summaryrefslogtreecommitdiffstats
path: root/spec/rtems/io/if/putk.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/io/if/putk.yml')
-rw-r--r--spec/rtems/io/if/putk.yml47
1 files changed, 47 insertions, 0 deletions
diff --git a/spec/rtems/io/if/putk.yml b/spec/rtems/io/if/putk.yml
new file mode 100644
index 00000000..88e3067a
--- /dev/null
+++ b/spec/rtems/io/if/putk.yml
@@ -0,0 +1,47 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Outputs the characters of the string and a newline character to the kernel
+ character output device.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2015 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ attributes: null
+ body: null
+ params:
+ - const char *${.:/params[0]/name}
+ return: int
+ variants: []
+description: null
+enabled-by: true
+index-entries: []
+interface-type: function
+links:
+- role: interface-placement
+ uid: header-3
+- role: interface-ingroup
+ uid: group-3
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
+name: putk
+notes: |
+ The directive may be used to print debug and test information. It uses
+ ${putc:/name} to output the characters. This directive performs a character
+ translation from ``NL`` to ``CR`` followed by ``NR``.
+
+ If the kernel character output device is concurrently accessed, then
+ interleaved output may occur.
+params:
+- description: |
+ is the string to output.
+ dir: null
+ name: s
+return:
+ return: |
+ Returns the number of characters output to the kernel character output
+ device.
+ return-values: []
+type: interface