Help¶

RX ring buffer size impacts accepted latency of handling incoming bytes by shell. If shell input is coming from the keyboard then it is usually enough if ring buffer is few bytes (more than one due to escape sequences). However, if bulk data is transferred it may be required to increase it.

Direct dependencies¶

SHELL_BACKEND_SERIAL && SHELL_BACKENDS && SHELL

(Includes any dependencies from ifs and menus.)

Default¶

64

Kconfig definition¶

At <Zephyr>/subsys/shell/Kconfig.backends:67

Included via <Zephyr>/Kconfig:8 → <Zephyr>/Kconfig.zephyr:34 → <Zephyr>/subsys/Kconfig:38 → <Zephyr>/subsys/shell/Kconfig:18

Menu path: (Top) → Sub Systems and OS Services → Shell → Enable shell backends → Enable serial backend

config SHELL_BACKEND_SERIAL_RX_RING_BUFFER_SIZE
    int "Set RX ring buffer size"
    default 64
    depends on SHELL_BACKEND_SERIAL && SHELL_BACKENDS && SHELL
    help
      RX ring buffer size impacts accepted latency of handling incoming
      bytes by shell. If shell input is coming from the keyboard then it is
      usually enough if ring buffer is few bytes (more than one due to
      escape sequences). However, if bulk data is transferred it may be
      required to increase it.

(The ‘depends on’ condition includes propagated dependencies from ifs and menus.)