michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: hid-cdc: cleanups

Browse source 
Similar cleanups to other samples.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2020-05-04 14:00:47 -07:00 • committed by Carles Cufí
commit 59e63845d1
2 changed files with 59 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

25
samples/subsys/usb/hid-cdc/README.rst
View file

@ -1,7 +1,7 @@
.. _usb_hid-cdc: .. _usb_hid-cdc:
USB HID CDC ACM Application USB HID CDC ACM Application
################################ ###########################
Overview Overview
******** ********
@ -16,16 +16,33 @@ Requirements
This project requires an USB device driver and multiple endpoints. This project requires an USB device driver and multiple endpoints.
The board hardware must have a push button connected via a GPIO pin. These are
called "User buttons" on many of Zephyr's :ref:`boards`.
The button must be configured using the ``sw0`` :ref:`devicetree <dt-guide>`
alias, usually in the :ref:`BOARD.dts file <devicetree-in-out-files>`. You will
see this error if you try to build this sample for an unsupported board:
.. code-block:: none
Unsupported board: sw0 devicetree alias is not defined
You may see additional build errors if the ``sw0`` alias exists, but is not
properly defined.
If the devicetree aliases ``sw1``, ``sw2``, and ``sw3`` are defined, they will
also be used as additional buttons as described below.
Building and Running Building and Running
******************** ********************
This sample can be built for multiple boards, in this example we will build it This sample can be built for multiple boards. To build and flash it
for the nrf52840dk_nrf52840 board: for the :ref:`nrf52840dk_nrf52840` board:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/subsys/usb/hid-cdc :zephyr-app: samples/subsys/usb/hid-cdc
:board: nrf52840dk_nrf52840 :board: nrf52840dk_nrf52840
:goals: build :goals: build flash
:compact: :compact:
After you have built and flashed the sample app image to your board, plug the After you have built and flashed the sample app image to your board, plug the

88
samples/subsys/usb/hid-cdc/src/main.c
View file

@ -17,58 +17,46 @@
#define LOG_LEVEL LOG_LEVEL_DBG #define LOG_LEVEL LOG_LEVEL_DBG
LOG_MODULE_REGISTER(main); LOG_MODULE_REGISTER(main);
#if DT_NODE_HAS_PROP(DT_ALIAS(sw0), gpios) #define FLAGS_OR_ZERO(node) \
#define PORT0 DT_GPIO_LABEL(DT_ALIAS(sw0), gpios) COND_CODE_1(DT_PHA_HAS_CELL(node, gpios, flags), \
(DT_GPIO_FLAGS(node, gpios)), \
(0))
#define SW0_NODE DT_ALIAS(sw0)
#if DT_NODE_HAS_STATUS(SW0_NODE, okay)
#define PORT0 DT_GPIO_LABEL(SW0_NODE, gpios)
#define PIN0 DT_GPIO_PIN(SW0_NODE, gpios)
#define PIN0_FLAGS FLAGS_OR_ZERO(SW0_NODE)
#else #else
#error DT_GPIO_LABEL(DT_ALIAS(sw0), gpios) needs to be set #error "Unsupported board: sw0 devicetree alias is not defined"
#define PORT0 ""
#define PIN0 0
#define PIN0_FLAGS 0
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw0), gpios, pin) #define SW1_NODE DT_ALIAS(sw1)
#define PIN0 DT_GPIO_PIN(DT_ALIAS(sw0), gpios)
#else #if DT_NODE_HAS_STATUS(SW1_NODE, okay)
#error DT_GPIO_PIN(DT_ALIAS(sw0), gpios) needs to be set #define PORT1 DT_GPIO_LABEL(SW1_NODE, gpios)
#define PIN1 DT_GPIO_PIN(SW1_NODE, gpios)
#define PIN1_FLAGS FLAGS_OR_ZERO(SW1_NODE)
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw0), gpios, flags) #define SW2_NODE DT_ALIAS(sw2)
#define PIN0_FLAGS DT_GPIO_FLAGS(DT_ALIAS(sw0), gpios)
#else #if DT_NODE_HAS_STATUS(SW2_NODE, okay)
#error DT_GPIO_FLAGS(DT_ALIAS(sw0), gpios) needs to be set #define PORT2 DT_GPIO_LABEL(SW2_NODE, gpios)
#define PIN2 DT_GPIO_PIN(SW2_NODE, gpios)
#define PIN2_FLAGS FLAGS_OR_ZERO(SW2_NODE)
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw1), gpios, pin) #define SW3_NODE DT_ALIAS(sw3)
#define PIN1 DT_GPIO_PIN(DT_ALIAS(sw1), gpios)
#endif
#if DT_NODE_HAS_PROP(DT_ALIAS(sw1), gpios) #if DT_NODE_HAS_STATUS(SW3_NODE, okay)
#define PORT1 DT_GPIO_LABEL(DT_ALIAS(sw1), gpios) #define PORT3 DT_GPIO_LABEL(SW3_NODE, gpios)
#endif #define PIN3 DT_GPIO_PIN(SW3_NODE, gpios)
#define PIN3_FLAGS FLAGS_OR_ZERO(SW3_NODE)
#if DT_PHA_HAS_CELL(DT_ALIAS(sw1), gpios, flags)
#define PIN1_FLAGS DT_GPIO_FLAGS(DT_ALIAS(sw1), gpios)
#endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw2), gpios, pin)
#define PIN2 DT_GPIO_PIN(DT_ALIAS(sw2), gpios)
#endif
#if DT_NODE_HAS_PROP(DT_ALIAS(sw2), gpios)
#define PORT2 DT_GPIO_LABEL(DT_ALIAS(sw2), gpios)
#endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw2), gpios, flags)
#define PIN2_FLAGS DT_GPIO_FLAGS(DT_ALIAS(sw2), gpios)
#endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw3), gpios, pin)
#define PIN3 DT_GPIO_PIN(DT_ALIAS(sw3), gpios)
#endif
#if DT_NODE_HAS_PROP(DT_ALIAS(sw3), gpios)
#define PORT3 DT_GPIO_LABEL(DT_ALIAS(sw3), gpios)
#endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw3), gpios, flags)
#define PIN3_FLAGS DT_GPIO_FLAGS(DT_ALIAS(sw3), gpios)
#endif #endif
/* Event FIFO */ /* Event FIFO */
@ -501,7 +489,7 @@ static void btn0(struct device *gpio, struct gpio_callback *cb, u32_t pins)
k_sem_give(&evt_sem); k_sem_give(&evt_sem);
} }
#if DT_PHA_HAS_CELL(DT_ALIAS(sw1), gpios, pin) #if DT_NODE_HAS_STATUS(SW1_NODE, okay)
static void btn1(struct device *gpio, struct gpio_callback *cb, u32_t pins) static void btn1(struct device *gpio, struct gpio_callback *cb, u32_t pins)
{ {
struct app_evt_t *ev = app_evt_alloc(); struct app_evt_t *ev = app_evt_alloc();
@ -512,7 +500,7 @@ static void btn1(struct device *gpio, struct gpio_callback *cb, u32_t pins)
} }
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw2), gpios, pin) #if DT_NODE_HAS_STATUS(SW2_NODE, okay)
static void btn2(struct device *gpio, struct gpio_callback *cb, u32_t pins) static void btn2(struct device *gpio, struct gpio_callback *cb, u32_t pins)
{ {
struct app_evt_t *ev = app_evt_alloc(); struct app_evt_t *ev = app_evt_alloc();
@ -523,7 +511,7 @@ static void btn2(struct device *gpio, struct gpio_callback *cb, u32_t pins)
} }
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw3), gpios, pin) #if DT_NODE_HAS_STATUS(SW3_NODE, okay)
static void btn3(struct device *gpio, struct gpio_callback *cb, u32_t pins) static void btn3(struct device *gpio, struct gpio_callback *cb, u32_t pins)
{ {
struct app_evt_t *ev = app_evt_alloc(); struct app_evt_t *ev = app_evt_alloc();
@ -598,7 +586,7 @@ void main(void)
return; return;
} }
#if DT_PHA_HAS_CELL(DT_ALIAS(sw1), gpios, pin) #if DT_NODE_HAS_STATUS(SW1_NODE, okay)
if (callbacks_configure(device_get_binding(PORT1), PIN1, PIN1_FLAGS, if (callbacks_configure(device_get_binding(PORT1), PIN1, PIN1_FLAGS,
&btn1, &callback[1])) { &btn1, &callback[1])) {
LOG_ERR("Failed configuring button 1 callback."); LOG_ERR("Failed configuring button 1 callback.");
@ -606,7 +594,7 @@ void main(void)
} }
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw2), gpios, pin) #if DT_NODE_HAS_STATUS(SW2_NODE, okay)
if (callbacks_configure(device_get_binding(PORT2), PIN2, PIN2_FLAGS, if (callbacks_configure(device_get_binding(PORT2), PIN2, PIN2_FLAGS,
&btn2, &callback[2])) { &btn2, &callback[2])) {
LOG_ERR("Failed configuring button 2 callback."); LOG_ERR("Failed configuring button 2 callback.");
@ -614,7 +602,7 @@ void main(void)
} }
#endif #endif
#if DT_PHA_HAS_CELL(DT_ALIAS(sw3), gpios, pin) #if DT_NODE_HAS_STATUS(SW3_NODE, okay)
if (callbacks_configure(device_get_binding(PORT3), PIN3, PIN3_FLAGS, if (callbacks_configure(device_get_binding(PORT3), PIN3, PIN3_FLAGS,
&btn3, &callback[3])) { &btn3, &callback[3])) {
LOG_ERR("Failed configuring button 3 callback."); LOG_ERR("Failed configuring button 3 callback.");