SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Outputs the characters defined by the format string and the arguments to the
  kernel character output device.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 2015 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: ${../../basedefs/if/printflike:/name}( 1, 2 )
    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-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
- role: constraint
  uid: ../constraint/no-floating-point
name: printk
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 a printf()-style format string.
  dir: null
  name: fmt
- description: |
    is a list of optional parameters required by the format string.
  dir: null
  name: '...'
return:
  return: |
    Returns the number of characters output to the kernel character output
    device.
  return-values: []
type: interface