usbh_pipes.h

00001 /**
00002   ******************************************************************************
00003   * @file    usbh_pipes.h
00004   * @author  MCD Application Team
00005   * @version V3.2.2
00006   * @date    07-July-2015
00007   * @brief   Header file for usbh_pipes.c
00008   ******************************************************************************
00009   * @attention
00010   *
00011   * <h2><center>&copy; COPYRIGHT 2015 STMicroelectronics</center></h2>
00012   *
00013   * Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
00014   * You may not use this file except in compliance with the License.
00015   * You may obtain a copy of the License at:
00016   *
00017   *        http://www.st.com/software_license_agreement_liberty_v2
00018   *
00019   * Unless required by applicable law or agreed to in writing, software 
00020   * distributed under the License is distributed on an "AS IS" BASIS, 
00021   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00022   * See the License for the specific language governing permissions and
00023   * limitations under the License.
00024   *
00025   ******************************************************************************
00026   */ 
00027 
00028 /* Define to prevent recursive  ----------------------------------------------*/
00029 #ifndef __USBH_PIPES_H
00030 #define __USBH_PIPES_H
00031 
00032 #ifdef __cplusplus
00033  extern "C" {
00034 #endif
00035 
00036 /* Includes ------------------------------------------------------------------*/
00037 #include "usbh_core.h"
00038 
00039 /** @addtogroup USBH_LIB
00040   * @{
00041   */
00042 
00043 /** @addtogroup USBH_LIB_CORE
00044 * @{
00045 */
00046   
00047 /** @defgroup USBH_PIPES
00048   * @brief This file is the header file for usbh_pipes.c
00049   * @{
00050   */ 
00051 
00052 /** @defgroup USBH_PIPES_Exported_Defines
00053   * @{
00054   */
00055 /**
00056   * @}
00057   */ 
00058 
00059 /** @defgroup USBH_PIPES_Exported_Types
00060   * @{
00061   */ 
00062 /**
00063   * @}
00064   */ 
00065 
00066 
00067 /** @defgroup USBH_PIPES_Exported_Macros
00068   * @{
00069   */ 
00070 /**
00071   * @}
00072   */ 
00073 
00074 /** @defgroup USBH_PIPES_Exported_Variables
00075   * @{
00076   */ 
00077 /**
00078   * @}
00079   */ 
00080 
00081 /** @defgroup USBH_PIPES_Exported_FunctionsPrototype
00082   * @{
00083   */
00084 
00085 USBH_StatusTypeDef USBH_OpenPipe  (USBH_HandleTypeDef *phost,
00086                             uint8_t ch_num,
00087                             uint8_t epnum,                            
00088                             uint8_t dev_address,
00089                             uint8_t speed,
00090                             uint8_t ep_type,
00091                             uint16_t mps);
00092 
00093 USBH_StatusTypeDef USBH_ClosePipe  (USBH_HandleTypeDef *phost,
00094                             uint8_t pipe_num);
00095 
00096 uint8_t USBH_AllocPipe  (USBH_HandleTypeDef *phost, 
00097                          uint8_t ep_addr);
00098 
00099 USBH_StatusTypeDef USBH_FreePipe  (USBH_HandleTypeDef *phost, 
00100                                    uint8_t idx);
00101 
00102 
00103 
00104 
00105 /**
00106   * @}
00107   */ 
00108 
00109 
00110 #ifdef __cplusplus
00111 }
00112 #endif
00113 
00114 #endif /* __USBH_PIPES_H */
00115 
00116 
00117 /**
00118   * @}
00119   */ 
00120 
00121 /**
00122   * @}
00123   */ 
00124 
00125 /**
00126 * @}
00127 */ 
00128 
00129 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
00130 
00131