00001 /* ---------------------------------------------------------------------------- */ 00002 /* Atmel Microcontroller Software Support */ 00003 /* SAM Software Package License */ 00004 /* ---------------------------------------------------------------------------- */ 00005 /* Copyright (c) 2015, Atmel Corporation */ 00006 /* */ 00007 /* All rights reserved. */ 00008 /* */ 00009 /* Redistribution and use in source and binary forms, with or without */ 00010 /* modification, are permitted provided that the following condition is met: */ 00011 /* */ 00012 /* - Redistributions of source code must retain the above copyright notice, */ 00013 /* this list of conditions and the disclaimer below. */ 00014 /* */ 00015 /* Atmel's name may not be used to endorse or promote products derived from */ 00016 /* this software without specific prior written permission. */ 00017 /* */ 00018 /* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */ 00019 /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */ 00020 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */ 00021 /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */ 00022 /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */ 00023 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */ 00024 /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */ 00025 /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */ 00026 /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */ 00027 /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ 00028 /* ---------------------------------------------------------------------------- */ 00029 00030 /** 00031 * \file 00032 * 00033 * \brief Common API for USB Host Interface 00034 */ 00035 /* 00036 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> 00037 */ 00038 00039 #ifndef _UHI_H_ 00040 #define _UHI_H_ 00041 00042 #include "USBH.h" 00043 00044 #ifdef __cplusplus 00045 extern "C" { 00046 #endif 00047 00048 /** 00049 * \ingroup usb_host_group 00050 * \defgroup uhi_group USB Host Interface (UHI) 00051 * The UHI provides a common API for all classes, 00052 * and this is used by UHC for the main control of USB host interface. 00053 * @{ 00054 */ 00055 00056 /** 00057 * \brief UHI API. 00058 * 00059 * The callbacks within this structure are called only by 00060 * USB Host Controller (UHC) 00061 */ 00062 typedef struct { 00063 /** 00064 * \brief Install interface 00065 * Allocate interface endpoints if supported. 00066 * 00067 * \param USBH_device_t Device to request 00068 * 00069 * \return status of the install 00070 */ 00071 USBH_enum_status_t (*install)(USBH_device_t *); 00072 00073 /** 00074 * \brief Enable the interface. 00075 * 00076 * Enable a USB interface corresponding to UHI. 00077 * 00078 * \param USBH_device_t Device to request 00079 */ 00080 void (*enable)(USBH_device_t *); 00081 00082 /** 00083 * \brief Uninstall the interface (if installed) 00084 * 00085 * \param USBH_device_t Device to request 00086 */ 00087 void (*uninstall)(USBH_device_t *); 00088 00089 /** 00090 * \brief Signal that a SOF has occurred 00091 */ 00092 void (*sof_notify)(bool b_micro); 00093 } uhi_api_t; 00094 00095 //@} 00096 00097 #ifdef __cplusplus 00098 } 00099 #endif 00100 #endif // _UHI_H_