30680c6eb3
* Massdrop SAMD51 Massdrop SAMD51 keyboards initial project upload * Removing relocated files Removing files that were relocated and not deleted from previous location * LED queue fix and cleaning Cleaned some white space or comments. Fix for LED I2C command queue. Cleaned up interrupts. Added debug function for printing numbers to scope through m15 line. * Factory programmed serial usage Ability to use factory programmed serial in hub and keyboard usb descriptors * USB serial number and bugfix Added support for factory programmed serial and usage. Incorporated bootloader's conditional compiling to align project closer. Fixed issue when USB device attempted to send before enabled. General white space and comment cleanup. * Project cleanup Cleaned up project in terms of white space, commented code, and unecessary files. NKRO keyboard is now using correct setreport although KBD was fine to use. Fixed broken linkage to __xprintf for serial debug statements. * Fix for extra keys Fixed possible USB hang on extra keys report set missing * I2C cleanup I2C cleanup and file renames necessary for master branch merge * Boot tracing and clocks cleanup Added optional boot debug trace mode through debug LED codes. General clock code cleanup. * Relocate ARM/Atmel headers Moved ARM/Atmel header folder from drivers to lib and made necessary makefile changes. * Pull request changes Pull request changes * Keymap and compile flag fix Keymap fix for momentary layer. Potential compile flag fix for Travis CI failure. * va_list include fix Fix for va_list compile failure * Include file case fixes Fixes for include files with incorrect case * ctrl and alt67 keyboard readme Added ctrl and alt67 keyboard readme files
134 lines
4.2 KiB
C
134 lines
4.2 KiB
C
/**
|
|
* \file
|
|
*
|
|
* \brief Common API for USB Device Interface
|
|
*
|
|
* Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
|
|
*
|
|
* \asf_license_start
|
|
*
|
|
* \page License
|
|
*
|
|
* 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 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. The name of Atmel may not be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 4. This software may only be redistributed and used in connection with an
|
|
* Atmel microcontroller product.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
|
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
|
|
*
|
|
* \asf_license_stop
|
|
*
|
|
*/
|
|
/*
|
|
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
|
|
*/
|
|
|
|
#ifndef _UDI_H_
|
|
#define _UDI_H_
|
|
|
|
#include "conf_usb.h"
|
|
#include "usb_protocol.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \ingroup usb_device_group
|
|
* \defgroup udi_group USB Device Interface (UDI)
|
|
* The UDI provides a common API for all classes,
|
|
* and this is used by UDC for the main control of USB Device interface.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* \brief UDI API.
|
|
*
|
|
* The callbacks within this structure are called only by
|
|
* USB Device Controller (UDC)
|
|
*
|
|
* The udc_get_interface_desc() can be use by UDI to know the interface descriptor
|
|
* selected by UDC.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* \brief Enable the interface.
|
|
*
|
|
* This function is called when the host selects a configuration
|
|
* to which this interface belongs through a Set Configuration
|
|
* request, and when the host selects an alternate setting of
|
|
* this interface through a Set Interface request.
|
|
*
|
|
* \return \c 1 if function was successfully done, otherwise \c 0.
|
|
*/
|
|
bool(*enable) (void);
|
|
|
|
/**
|
|
* \brief Disable the interface.
|
|
*
|
|
* This function is called when this interface is currently
|
|
* active, and
|
|
* - the host selects any configuration through a Set
|
|
* Configuration request, or
|
|
* - the host issues a USB reset, or
|
|
* - the device is detached from the host (i.e. Vbus is no
|
|
* longer present)
|
|
*/
|
|
void (*disable) (void);
|
|
|
|
/**
|
|
* \brief Handle a control request directed at an interface.
|
|
*
|
|
* This function is called when this interface is currently
|
|
* active and the host sends a SETUP request
|
|
* with this interface as the recipient.
|
|
*
|
|
* Use udd_g_ctrlreq to decode and response to SETUP request.
|
|
*
|
|
* \return \c 1 if this interface supports the SETUP request, otherwise \c 0.
|
|
*/
|
|
bool(*setup) (void);
|
|
|
|
/**
|
|
* \brief Returns the current setting of the selected interface.
|
|
*
|
|
* This function is called when UDC when know alternate setting of selected interface.
|
|
*
|
|
* \return alternate setting of selected interface
|
|
*/
|
|
uint8_t(*getsetting) (void);
|
|
|
|
/**
|
|
* \brief To signal that a SOF is occurred
|
|
*/
|
|
void(*sof_notify) (void);
|
|
} udi_api_t;
|
|
|
|
//@}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif // _UDI_H_
|