4 * \brief Common API for USB Device Interface
6 * Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright notice,
19 * this list of conditions and the following disclaimer in the documentation
20 * and/or other materials provided with the distribution.
22 * 3. The name of Atmel may not be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * 4. This software may only be redistributed and used in connection with an
26 * Atmel microcontroller product.
28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
44 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
51 #include "usb_protocol.h"
58 * \ingroup usb_device_group
59 * \defgroup udi_group USB Device Interface (UDI)
60 * The UDI provides a common API for all classes,
61 * and this is used by UDC for the main control of USB Device interface.
68 * The callbacks within this structure are called only by
69 * USB Device Controller (UDC)
71 * The udc_get_interface_desc() can be use by UDI to know the interface descriptor
76 * \brief Enable the interface.
78 * This function is called when the host selects a configuration
79 * to which this interface belongs through a Set Configuration
80 * request, and when the host selects an alternate setting of
81 * this interface through a Set Interface request.
83 * \return \c 1 if function was successfully done, otherwise \c 0.
88 * \brief Disable the interface.
90 * This function is called when this interface is currently
92 * - the host selects any configuration through a Set
93 * Configuration request, or
94 * - the host issues a USB reset, or
95 * - the device is detached from the host (i.e. Vbus is no
98 void (*disable) (void);
101 * \brief Handle a control request directed at an interface.
103 * This function is called when this interface is currently
104 * active and the host sends a SETUP request
105 * with this interface as the recipient.
107 * Use udd_g_ctrlreq to decode and response to SETUP request.
109 * \return \c 1 if this interface supports the SETUP request, otherwise \c 0.
114 * \brief Returns the current setting of the selected interface.
116 * This function is called when UDC when know alternate setting of selected interface.
118 * \return alternate setting of selected interface
120 uint8_t(*getsetting) (void);
123 * \brief To signal that a SOF is occurred
125 void(*sof_notify) (void);