usbd_msg.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_USBD_MSG_H_
#define ZEPHYR_INCLUDE_USBD_MSG_H_
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif


enum usbd_msg_type {
        USBD_MSG_VBUS_READY,
        USBD_MSG_VBUS_REMOVED,
        USBD_MSG_RESUME,
        USBD_MSG_SUSPEND,
        USBD_MSG_RESET,
        USBD_MSG_CONFIGURATION,
        USBD_MSG_UDC_ERROR,
        USBD_MSG_STACK_ERROR,
        USBD_MSG_CDC_ACM_LINE_CODING,
        USBD_MSG_CDC_ACM_CONTROL_LINE_STATE,
        USBD_MSG_DFU_APP_DETACH,
        USBD_MSG_DFU_DOWNLOAD_COMPLETED,
        USBD_MSG_MAX_NUMBER,
};

static const char *const usbd_msg_type_list[] = {
        "VBUS ready",
        "VBUS removed",
        "Device resumed",
        "Device suspended",
        "Bus reset",
        "New device configuration",
        "Controller error",
        "Stack error",
        "CDC ACM line coding",
        "CDC ACM control line state",
        "DFU detach request",
        "DFU download completed",
};
 
BUILD_ASSERT(ARRAY_SIZE(usbd_msg_type_list) == USBD_MSG_MAX_NUMBER,
             "Number of entries in usbd_msg_type_list is not equal to USBD_MSG_MAX_NUMBER");

struct usbd_msg {
        enum usbd_msg_type type;
        union {
                int status;
                const struct device *dev;
        };
};

static inline const char *usbd_msg_type_string(const enum usbd_msg_type type)
{
        if (type >= 0 && type < USBD_MSG_MAX_NUMBER) {
                return usbd_msg_type_list[type];
        }
 
        return "?";
}

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USBD_MSG_H_ */