/** * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA * * All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * 2. Redistributions in binary form, except as embedded into a Nordic * Semiconductor ASA integrated circuit in a product or a software update for * such product, must reproduce the above copyright notice, this list of * conditions and the following disclaimer in the documentation and/or other * materials provided with the distribution. * * 3. Neither the name of Nordic Semiconductor ASA nor the names of its * contributors may be used to endorse or promote products derived from this * software without specific prior written permission. * * 4. This software, with or without modification, must only be used with a * Nordic Semiconductor ASA integrated circuit. * * 5. Any software provided in binary form under this license must not be reverse * engineered, decompiled, modified and/or disassembled. * * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * */ #ifndef APP_USBD_CDC_DESC_H__ #define APP_USBD_CDC_DESC_H__ #include #include #include "app_usbd_descriptor.h" #include "app_usbd_cdc_types.h" #ifdef __cplusplus extern "C" { #endif /** * @defgroup app_usbd_cdc_desc CDC class descriptors * @brief @tagAPI52840 Descriptors used in the USB CDC class implementation. * @ingroup app_usbd_cdc_acm * * A group of macros used to initialize CDC descriptors * @{ */ /** * @brief Initializer of IAD descriptor for CDC class. * * @param interface_number Interface number. * @param subclass Subclass, @ref app_usbd_cdc_subclass_t. * @param protocol Protocol, @ref app_usbd_cdc_comm_protocol_t. */ #define APP_USBD_CDC_IAD_DSC(interface_number, subclass, protocol) \ /*.bLength = */ sizeof(app_usbd_descriptor_iad_t), \ /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE_ASSOCIATION, \ /*.bFirstInterface = */ interface_number, \ /*.bInterfaceCount = */ 2, \ /*.bFunctionClass = */ APP_USBD_CDC_COMM_CLASS, \ /*.bFunctionSubClass = */ subclass, \ /*.bFunctionProtocol = */ protocol, \ /*.iFunction = */ 0, \ /** * @brief Initializer of interface descriptor for CDC COMM class. * * @param interface_number Interface number. * @param subclass Subclass, @ref app_usbd_cdc_subclass_t. * @param protocol Protocol, @ref app_usbd_cdc_comm_protocol_t. */ #define APP_USBD_CDC_COMM_INTERFACE_DSC(interface_number, subclass, protocol) \ /*.bLength = */ sizeof(app_usbd_descriptor_iface_t), \ /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE, \ /*.bInterfaceNumber = */ interface_number, \ /*.bAlternateSetting = */ 0x00, \ /*.bNumEndpoints = */ 1, \ /*.bInterfaceClass = */ APP_USBD_CDC_COMM_CLASS, \ /*.bInterfaceSubClass = */ subclass, \ /*.bInterfaceProtocol = */ protocol, \ /*.iInterface = 0, */ 0x00, \ /** * @brief Initializer of interface descriptor for CDC DATA class. * * @param interface_number Interface number. * @param subclass Subclass, @ref app_usbd_cdc_subclass_t. * @param protocol Protocol, @ref app_usbd_cdc_data_protocol_t. */ #define APP_USBD_CDC_DATA_INTERFACE_DSC(interface_number, subclass, protocol) \ /*.bLength = */ sizeof(app_usbd_descriptor_iface_t), \ /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE, \ /*.bInterfaceNumber = */ interface_number, \ /*.bAlternateSetting = */ 0x00, \ /*.bNumEndpoints = */ 2, \ /*.bInterfaceClass = */ APP_USBD_CDC_DATA_CLASS, \ /*.bInterfaceSubClass = */ subclass, \ /*.bInterfaceProtocol = */ protocol, \ /*.iInterface = 0, */ 0x00, \ /** * @brief Initializer of endpoint descriptor for CDC COM class. * * @param endpoint_in IN endpoint. * @param ep_size Endpoint size. */ #define APP_USBD_CDC_COM_EP_DSC(endpoint_in, ep_size) \ /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \ /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \ /*.bEndpointAddress = */ endpoint_in, \ /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_INTERRUPT, \ /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \ /*.bInterval = */ 16, \ /** * @brief Initializer of endpoint descriptors for CDC DATA class. * * @param endpoint_in IN endpoint. * @param endpoint_out OUT endpoint. * @param ep_size Endpoint size. */ #define APP_USBD_CDC_DATA_EP_DSC(endpoint_in, endpoint_out, ep_size) \ /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \ /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \ /*.bEndpointAddress = */ endpoint_in, \ /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_BULK, \ /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \ /*.bInterval = */ 0, \ /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \ /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \ /*.bEndpointAddress = */ endpoint_out, \ /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_BULK, \ /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \ /*.bInterval = */ 0, \ /** * @brief Initializer of endpoint descriptors for CDC header descriptor. * * @param bcd_cdc BCD CDC version. */ #define APP_USBD_CDC_HEADER_DSC(bcd_cdc) \ /*.bLength = */ sizeof(app_usbd_cdc_desc_header_t), \ /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \ /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_HEADER, \ /*.bcdCDC = */ APP_USBD_U16_TO_RAW_DSC(bcd_cdc), \ /** * @brief Initializer of endpoint descriptors for CDC call management descriptor. * * @param capabilities Capabilities. * @param data_interface Data interface. */ #define APP_USBD_CDC_CALL_MGMT_DSC(capabilities, data_interface) \ /*.bLength = */ sizeof(app_usbd_cdc_desc_call_mgmt_t), \ /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \ /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_CALL_MGMT, \ /*.bmCapabilities = */ capabilities, \ /*.bDataInterface = */ data_interface, \ /** * @brief Initializer of endpoint descriptors for CDC DATA class. * * @param capabilities Capabilities. */ #define APP_USBD_CDC_ACM_DSC(capabilities) \ /*.bLength = */ sizeof(app_usbd_cdc_desc_acm_t), \ /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \ /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_ACM, \ /*.bmCapabilities = */ capabilities, \ /** * @brief Initializer of endpoint descriptors for CDC DATA class. * * @param control_interface Control interface. * @param ... Subordinate interfaces list. */ #define APP_USBD_CDC_UNION_DSC(control_interface, ...) \ /*.bLength = */ sizeof(app_usbd_cdc_desc_union_t) + (NUM_VA_ARGS(__VA_ARGS__)), \ /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \ /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_UNION, \ /*.bControlInterface = */ control_interface, \ /*.bSubordinateInterface = */ __VA_ARGS__, \ /** @} */ #ifdef __cplusplus } #endif #endif /* APP_USBD_CDC_H__ */