xref: /btstack/port/stm32-f4discovery-usb/Middlewares/ST/STM32_USB_Host_Library/Core/Inc/usbh_pipes.h (revision a8f7f3fcbcd51f8d2e92aca076b6a9f812db358c)
1 /**
2   ******************************************************************************
3   * @file    usbh_pipes.h
4   * @author  MCD Application Team
5   * @brief   Header file for usbh_pipes.c
6   ******************************************************************************
7   * @attention
8   *
9   * <h2><center>&copy; Copyright (c) 2015 STMicroelectronics.
10   * All rights reserved.</center></h2>
11   *
12   * This software component is licensed by ST under Ultimate Liberty license
13   * SLA0044, the "License"; You may not use this file except in compliance with
14   * the License. You may obtain a copy of the License at:
15   *                      www.st.com/SLA0044
16   *
17   ******************************************************************************
18   */
19 
20 /* Define to prevent recursive  ----------------------------------------------*/
21 #ifndef __USBH_PIPES_H
22 #define __USBH_PIPES_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "usbh_core.h"
30 
31 /** @addtogroup USBH_LIB
32   * @{
33   */
34 
35 /** @addtogroup USBH_LIB_CORE
36 * @{
37 */
38 
39 /** @defgroup USBH_PIPES
40   * @brief This file is the header file for usbh_pipes.c
41   * @{
42   */
43 
44 /** @defgroup USBH_PIPES_Exported_Defines
45   * @{
46   */
47 /**
48   * @}
49   */
50 
51 /** @defgroup USBH_PIPES_Exported_Types
52   * @{
53   */
54 /**
55   * @}
56   */
57 
58 
59 /** @defgroup USBH_PIPES_Exported_Macros
60   * @{
61   */
62 /**
63   * @}
64   */
65 
66 /** @defgroup USBH_PIPES_Exported_Variables
67   * @{
68   */
69 /**
70   * @}
71   */
72 
73 /** @defgroup USBH_PIPES_Exported_FunctionsPrototype
74   * @{
75   */
76 
77 USBH_StatusTypeDef USBH_OpenPipe(USBH_HandleTypeDef *phost,
78                                  uint8_t pipe_num,
79                                  uint8_t epnum,
80                                  uint8_t dev_address,
81                                  uint8_t speed,
82                                  uint8_t ep_type,
83                                  uint16_t mps);
84 
85 USBH_StatusTypeDef USBH_ClosePipe(USBH_HandleTypeDef *phost,
86                                   uint8_t pipe_num);
87 
88 uint8_t USBH_AllocPipe(USBH_HandleTypeDef *phost,
89                        uint8_t ep_addr);
90 
91 USBH_StatusTypeDef USBH_FreePipe(USBH_HandleTypeDef *phost,
92                                  uint8_t idx);
93 
94 
95 
96 
97 /**
98   * @}
99   */
100 
101 
102 #ifdef __cplusplus
103 }
104 #endif
105 
106 #endif /* __USBH_PIPES_H */
107 
108 
109 /**
110   * @}
111   */
112 
113 /**
114   * @}
115   */
116 
117 /**
118 * @}
119 */
120 
121 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
122 
123 
124