USBD string configuration

nRF5 SDK v13.1.0
Macros

nRF52840 only: Configuration of the string module that can be easily affected by the final user. More...

Macros

#define APP_USBD_STRINGS_LANGIDS ((uint16_t)APP_USBD_LANG_ENGLISH | (uint16_t)APP_USBD_SUBLANG_ENGLISH_US)
Supported languages identifiers. More...
#define APP_USBD_STRINGS_MANUFACTURER APP_USBD_STRING_DESC ('N', 'o', 'r', 'd', 'i', 'c', ' ', 'S', 'e', 'm', 'i', 'c', 'o', 'n', 'd', 'u', 'c', 't', 'o', 'r')
Manufacturer name string descriptor. More...
#define APP_USBD_STRINGS_MANUFACTURER_EXTERN 0
Define whether APP_USBD_STRINGS_MANUFACTURER is created by APP_USBD_STRING_DESC or declared as global variable.
#define APP_USBD_STRINGS_PRODUCT APP_USBD_STRING_DESC ('n', 'R', 'F', '5', '2', ' ', 'U', 'S', 'B', ' ', 'D', 'e', 'm', 'o')
Product name string descriptor. More...
#define APP_USBD_STRINGS_PRODUCT_EXTERN 0
Define whether APP_USBD_STRINGS_PRODUCT is created by APP_USBD_STRING_DESC or declared as global variable.
#define APP_USBD_STRING_SERIAL APP_USBD_STRING_DESC ('0', '0', '0', '0', '0', '0', '0', '0', '0', '0', '0', '0')
Serial number string descriptor. More...
#define APP_USBD_STRING_SERIAL_EXTERN 0
Define whether APP_USBD_STRING_SERIAL is created by APP_USBD_STRING_DESC or declared as global variable.
#define APP_USBD_STRINGS_USER X(APP_USER_1, , APP_USBD_STRING_DESC ('U', 's', 'e', 'r', ' ', '1'))
User strings default values. More...

Detailed Description

nRF52840 only: Configuration of the string module that can be easily affected by the final user.

Macro Definition Documentation

#define APP_USBD_STRING_SERIAL APP_USBD_STRING_DESC ('0', '0', '0', '0', '0', '0', '0', '0', '0', '0', '0', '0')

Serial number string descriptor.

Create serial number string descriptor using APP_USBD_STRING_DESC , or configure it to point to any internal variable pointer filled with descriptor.

Note
There is only one SERIAL number inside the library and it is Language independent.
#define APP_USBD_STRINGS_LANGIDS   ((uint16_t)APP_USBD_LANG_ENGLISH | (uint16_t)APP_USBD_SUBLANG_ENGLISH_US)

Supported languages identifiers.

Comma separated list of supported languages.

#define APP_USBD_STRINGS_MANUFACTURER APP_USBD_STRING_DESC ('N', 'o', 'r', 'd', 'i', 'c', ' ', 'S', 'e', 'm', 'i', 'c', 'o', 'n', 'd', 'u', 'c', 't', 'o', 'r')

Manufacturer name string descriptor.

Comma separated list of manufacturer names for each defined language. Use APP_USBD_STRING_DESC macro to create string descriptor.

The order of manufacturer names has to be the same like in APP_USBD_STRINGS_LANGIDS .

#define APP_USBD_STRINGS_PRODUCT APP_USBD_STRING_DESC ('n', 'R', 'F', '5', '2', ' ', 'U', 'S', 'B', ' ', 'D', 'e', 'm', 'o')

Product name string descriptor.

List of product names defined the same way like in APP_USBD_STRINGS_MANUFACTURER

#define APP_USBD_STRINGS_USER   X(APP_USER_1, , APP_USBD_STRING_DESC ('U', 's', 'e', 'r', ' ', '1'))

User strings default values.

This value stores all application specific user strings with its default initialization. The setup is done by X-macros. Expected macro parameters:

X(mnemonic, [=str_idx], ...)
  • mnemonic: Mnemonic of the string descriptor that would be added to app_usbd_string_desc_idx_t enumerator.
  • str_idx : String index value, may be set or left empty. For example WinUSB driver requires descriptor to be present on 0xEE index. Then use X(USBD_STRING_WINUSB, =0xEE, (APP_USBD_STRING_DESC(...)))
  • ... : List of string descriptors for each defined language.