2 * Copyright (c) 2013-2017 ARM Limited. All rights reserved.
4 * SPDX-License-Identifier: Apache-2.0
6 * Licensed under the Apache License, Version 2.0 (the License); you may
7 * not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
14 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 * Project: USB Host Driver definitions
26 * ARM_USBH_PORT_STATE made volatile
28 * Renamed structure ARM_USBH_EP_HANDLE to ARM_USBH_PIPE_HANDLE
29 * Renamed functions ARM_USBH_Endpoint... to ARM_USBH_Pipe...
30 * Renamed function ARM_USBH_SignalEndpointEvent to ARM_USBH_SignalPipeEvent
32 * Replaced function ARM_USBH_PortPowerOnOff with ARM_USBH_PortVbusOnOff
33 * Changed function ARM_USBH_EndpointCreate parameters
34 * Replaced function ARM_USBH_EndpointConfigure with ARM_USBH_EndpointModify
35 * Replaced function ARM_USBH_EndpointClearHalt with ARM_USBH_EndpointReset
36 * Replaced function ARM_USBH_URB_Submit with ARM_USBH_EndpointTransfer
37 * Replaced function ARM_USBH_URB_Abort with ARM_USBH_EndpointTransferAbort
38 * Added function ARM_USBH_EndpointTransferGetResult
39 * Added function ARM_USBH_GetFrameNumber
40 * Changed prefix ARM_DRV -> ARM_DRIVER
42 * Added API for OHCI/EHCI Host Controller Interface (HCI)
44 * Namespace prefix ARM_ added
49 #ifndef DRIVER_USBH_H_
50 #define DRIVER_USBH_H_
57 #include "Driver_USB.h"
59 #define ARM_USBH_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,2) /* API version */
63 \brief USB Host Port State
65 typedef volatile struct _ARM_USBH_PORT_STATE {
66 uint32_t connected : 1; ///< USB Host Port connected flag
67 uint32_t overcurrent : 1; ///< USB Host Port overcurrent flag
68 uint32_t speed : 2; ///< USB Host Port speed setting (ARM_USB_SPEED_xxx)
69 uint32_t reserved : 28;
70 } ARM_USBH_PORT_STATE;
73 \brief USB Host Pipe Handle
75 typedef uint32_t ARM_USBH_PIPE_HANDLE;
76 #define ARM_USBH_EP_HANDLE ARM_USBH_PIPE_HANDLE /* Legacy name */
79 /****** USB Host Packet Information *****/
80 #define ARM_USBH_PACKET_TOKEN_Pos 0
81 #define ARM_USBH_PACKET_TOKEN_Msk (0x0FUL << ARM_USBH_PACKET_TOKEN_Pos)
82 #define ARM_USBH_PACKET_SETUP (0x01UL << ARM_USBH_PACKET_TOKEN_Pos) ///< SETUP Packet
83 #define ARM_USBH_PACKET_OUT (0x02UL << ARM_USBH_PACKET_TOKEN_Pos) ///< OUT Packet
84 #define ARM_USBH_PACKET_IN (0x03UL << ARM_USBH_PACKET_TOKEN_Pos) ///< IN Packet
85 #define ARM_USBH_PACKET_PING (0x04UL << ARM_USBH_PACKET_TOKEN_Pos) ///< PING Packet
87 #define ARM_USBH_PACKET_DATA_Pos 4
88 #define ARM_USBH_PACKET_DATA_Msk (0x0FUL << ARM_USBH_PACKET_DATA_Pos)
89 #define ARM_USBH_PACKET_DATA0 (0x01UL << ARM_USBH_PACKET_DATA_Pos) ///< DATA0 PID
90 #define ARM_USBH_PACKET_DATA1 (0x02UL << ARM_USBH_PACKET_DATA_Pos) ///< DATA1 PID
92 #define ARM_USBH_PACKET_SPLIT_Pos 8
93 #define ARM_USBH_PACKET_SPLIT_Msk (0x0FUL << ARM_USBH_PACKET_SPLIT_Pos)
94 #define ARM_USBH_PACKET_SSPLIT (0x08UL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet
95 #define ARM_USBH_PACKET_SSPLIT_S (0x09UL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet: Data Start
96 #define ARM_USBH_PACKET_SSPLIT_E (0x0AUL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet: Data End
97 #define ARM_USBH_PACKET_SSPLIT_S_E (0x0BUL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet: Data All
98 #define ARM_USBH_PACKET_CSPLIT (0x0CUL << ARM_USBH_PACKET_SPLIT_Pos) ///< CSPLIT Packet
100 #define ARM_USBH_PACKET_PRE (1UL << 12) ///< PRE Token
103 /****** USB Host Port Event *****/
104 #define ARM_USBH_EVENT_CONNECT (1UL << 0) ///< USB Device Connected to Port
105 #define ARM_USBH_EVENT_DISCONNECT (1UL << 1) ///< USB Device Disconnected from Port
106 #define ARM_USBH_EVENT_OVERCURRENT (1UL << 2) ///< USB Device caused Overcurrent
107 #define ARM_USBH_EVENT_RESET (1UL << 3) ///< USB Reset completed
108 #define ARM_USBH_EVENT_SUSPEND (1UL << 4) ///< USB Suspend occurred
109 #define ARM_USBH_EVENT_RESUME (1UL << 5) ///< USB Resume occurred
110 #define ARM_USBH_EVENT_REMOTE_WAKEUP (1UL << 6) ///< USB Device activated Remote Wakeup
112 /****** USB Host Pipe Event *****/
113 #define ARM_USBH_EVENT_TRANSFER_COMPLETE (1UL << 0) ///< Transfer completed
114 #define ARM_USBH_EVENT_HANDSHAKE_NAK (1UL << 1) ///< NAK Handshake received
115 #define ARM_USBH_EVENT_HANDSHAKE_NYET (1UL << 2) ///< NYET Handshake received
116 #define ARM_USBH_EVENT_HANDSHAKE_MDATA (1UL << 3) ///< MDATA Handshake received
117 #define ARM_USBH_EVENT_HANDSHAKE_STALL (1UL << 4) ///< STALL Handshake received
118 #define ARM_USBH_EVENT_HANDSHAKE_ERR (1UL << 5) ///< ERR Handshake received
119 #define ARM_USBH_EVENT_BUS_ERROR (1UL << 6) ///< Bus Error detected
122 #ifndef __DOXYGEN_MW__ // exclude from middleware documentation
124 // Function documentation
126 \fn ARM_DRIVER_VERSION ARM_USBH_GetVersion (void)
127 \brief Get driver version.
128 \return \ref ARM_DRIVER_VERSION
131 \fn ARM_USBH_CAPABILITIES ARM_USBH_GetCapabilities (void)
132 \brief Get driver capabilities.
133 \return \ref ARM_USBH_CAPABILITIES
136 \fn int32_t ARM_USBH_Initialize (ARM_USBH_SignalPortEvent_t cb_port_event,
137 ARM_USBH_SignalPipeEvent_t cb_pipe_event)
138 \brief Initialize USB Host Interface.
139 \param[in] cb_port_event Pointer to \ref ARM_USBH_SignalPortEvent
140 \param[in] cb_pipe_event Pointer to \ref ARM_USBH_SignalPipeEvent
141 \return \ref execution_status
144 \fn int32_t ARM_USBH_Uninitialize (void)
145 \brief De-initialize USB Host Interface.
146 \return \ref execution_status
149 \fn int32_t ARM_USBH_PowerControl (ARM_POWER_STATE state)
150 \brief Control USB Host Interface Power.
151 \param[in] state Power state
152 \return \ref execution_status
155 \fn int32_t ARM_USBH_PortVbusOnOff (uint8_t port, bool vbus)
156 \brief Root HUB Port VBUS on/off.
157 \param[in] port Root HUB Port Number
161 \return \ref execution_status
164 \fn int32_t ARM_USBH_PortReset (uint8_t port)
165 \brief Do Root HUB Port Reset.
166 \param[in] port Root HUB Port Number
167 \return \ref execution_status
170 \fn int32_t ARM_USBH_PortSuspend (uint8_t port)
171 \brief Suspend Root HUB Port (stop generating SOFs).
172 \param[in] port Root HUB Port Number
173 \return \ref execution_status
176 \fn int32_t ARM_USBH_PortResume (uint8_t port)
177 \brief Resume Root HUB Port (start generating SOFs).
178 \param[in] port Root HUB Port Number
179 \return \ref execution_status
182 \fn ARM_USBH_PORT_STATE ARM_USBH_PortGetState (uint8_t port)
183 \brief Get current Root HUB Port State.
184 \param[in] port Root HUB Port Number
185 \return Port State \ref ARM_USBH_PORT_STATE
188 \fn ARM_USBH_PIPE_HANDLE ARM_USBH_PipeCreate (uint8_t dev_addr,
194 uint16_t ep_max_packet_size,
196 \brief Create Pipe in System.
197 \param[in] dev_addr Device Address
198 \param[in] dev_speed Device Speed
199 \param[in] hub_addr Hub Address
200 \param[in] hub_port Hub Port
201 \param[in] ep_addr Endpoint Address
202 - ep_addr.0..3: Address
203 - ep_addr.7: Direction
204 \param[in] ep_type Endpoint Type (ARM_USB_ENDPOINT_xxx)
205 \param[in] ep_max_packet_size Endpoint Maximum Packet Size
206 \param[in] ep_interval Endpoint Polling Interval
207 \return Pipe Handle \ref ARM_USBH_PIPE_HANDLE
210 \fn int32_t ARM_USBH_PipeModify (ARM_USBH_PIPE_HANDLE pipe_hndl,
215 uint16_t ep_max_packet_size)
216 \brief Modify Pipe in System.
217 \param[in] pipe_hndl Pipe Handle
218 \param[in] dev_addr Device Address
219 \param[in] dev_speed Device Speed
220 \param[in] hub_addr Hub Address
221 \param[in] hub_port Hub Port
222 \param[in] ep_max_packet_size Endpoint Maximum Packet Size
223 \return \ref execution_status
226 \fn int32_t ARM_USBH_PipeDelete (ARM_USBH_PIPE_HANDLE pipe_hndl)
227 \brief Delete Pipe from System.
228 \param[in] pipe_hndl Pipe Handle
229 \return \ref execution_status
232 \fn int32_t ARM_USBH_PipeReset (ARM_USBH_PIPE_HANDLE pipe_hndl)
234 \param[in] pipe_hndl Pipe Handle
235 \return \ref execution_status
238 \fn int32_t ARM_USBH_PipeTransfer (ARM_USBH_PIPE_HANDLE pipe_hndl,
242 \brief Transfer packets through USB Pipe.
243 \param[in] pipe_hndl Pipe Handle
244 \param[in] packet Packet information
245 \param[in] data Pointer to buffer with data to send or for data to receive
246 \param[in] num Number of data bytes to transfer
247 \return \ref execution_status
250 \fn uint32_t ARM_USBH_PipeTransferGetResult (ARM_USBH_PIPE_HANDLE pipe_hndl)
251 \brief Get result of USB Pipe transfer.
252 \param[in] pipe_hndl Pipe Handle
253 \return number of successfully transferred data bytes
256 \fn int32_t ARM_USBH_PipeTransferAbort (ARM_USBH_PIPE_HANDLE pipe_hndl)
257 \brief Abort current USB Pipe transfer.
258 \param[in] pipe_hndl Pipe Handle
259 \return \ref execution_status
262 \fn uint16_t ARM_USBH_GetFrameNumber (void)
263 \brief Get current USB Frame Number.
268 \fn void ARM_USBH_SignalPortEvent (uint8_t port, uint32_t event)
269 \brief Signal Root HUB Port Event.
270 \param[in] port Root HUB Port Number
271 \param[in] event \ref USBH_port_events
275 \fn void ARM_USBH_SignalPipeEvent (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event)
276 \brief Signal Pipe Event.
277 \param[in] pipe_hndl Pipe Handle
278 \param[in] event \ref USBH_pipe_events
282 typedef void (*ARM_USBH_SignalPortEvent_t) (uint8_t port, uint32_t event); ///< Pointer to \ref ARM_USBH_SignalPortEvent : Signal Root HUB Port Event.
283 typedef void (*ARM_USBH_SignalPipeEvent_t) (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event); ///< Pointer to \ref ARM_USBH_SignalPipeEvent : Signal Pipe Event.
284 #define ARM_USBH_SignalEndpointEvent_t ARM_USBH_SignalPipeEvent_t /* Legacy name */
288 \brief USB Host Driver Capabilities.
290 typedef struct _ARM_USBH_CAPABILITIES {
291 uint32_t port_mask : 15; ///< Root HUB available Ports Mask
292 uint32_t auto_split : 1; ///< Automatic SPLIT packet handling
293 uint32_t event_connect : 1; ///< Signal Connect event
294 uint32_t event_disconnect : 1; ///< Signal Disconnect event
295 uint32_t event_overcurrent : 1; ///< Signal Overcurrent event
296 uint32_t reserved : 13; ///< Reserved (must be zero)
297 } ARM_USBH_CAPABILITIES;
301 \brief Access structure of USB Host Driver.
303 typedef struct _ARM_DRIVER_USBH {
304 ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_USBH_GetVersion : Get driver version.
305 ARM_USBH_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_USBH_GetCapabilities : Get driver capabilities.
306 int32_t (*Initialize) (ARM_USBH_SignalPortEvent_t cb_port_event,
307 ARM_USBH_SignalPipeEvent_t cb_pipe_event); ///< Pointer to \ref ARM_USBH_Initialize : Initialize USB Host Interface.
308 int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_USBH_Uninitialize : De-initialize USB Host Interface.
309 int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_USBH_PowerControl : Control USB Host Interface Power.
310 int32_t (*PortVbusOnOff) (uint8_t port, bool vbus); ///< Pointer to \ref ARM_USBH_PortVbusOnOff : Root HUB Port VBUS on/off.
311 int32_t (*PortReset) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortReset : Do Root HUB Port Reset.
312 int32_t (*PortSuspend) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortSuspend : Suspend Root HUB Port (stop generating SOFs).
313 int32_t (*PortResume) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortResume : Resume Root HUB Port (start generating SOFs).
314 ARM_USBH_PORT_STATE (*PortGetState) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortGetState : Get current Root HUB Port State.
315 ARM_USBH_PIPE_HANDLE (*PipeCreate) (uint8_t dev_addr,
321 uint16_t ep_max_packet_size,
322 uint8_t ep_interval); ///< Pointer to \ref ARM_USBH_PipeCreate : Create Pipe in System.
323 int32_t (*PipeModify) (ARM_USBH_PIPE_HANDLE pipe_hndl,
328 uint16_t ep_max_packet_size); ///< Pointer to \ref ARM_USBH_PipeModify : Modify Pipe in System.
329 int32_t (*PipeDelete) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeDelete : Delete Pipe from System.
330 int32_t (*PipeReset) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeReset : Reset Pipe.
331 int32_t (*PipeTransfer) (ARM_USBH_PIPE_HANDLE pipe_hndl,
334 uint32_t num); ///< Pointer to \ref ARM_USBH_PipeTransfer : Transfer packets through USB Pipe.
335 uint32_t (*PipeTransferGetResult) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeTransferGetResult : Get result of USB Pipe transfer.
336 int32_t (*PipeTransferAbort) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeTransferAbort : Abort current USB Pipe transfer.
337 uint16_t (*GetFrameNumber) (void); ///< Pointer to \ref ARM_USBH_GetFrameNumber : Get current USB Frame Number.
338 } const ARM_DRIVER_USBH;
343 // Function documentation
345 \fn ARM_DRIVER_VERSION ARM_USBH_HCI_GetVersion (void)
346 \brief Get USB Host HCI (OHCI/EHCI) driver version.
347 \return \ref ARM_DRIVER_VERSION
350 \fn ARM_USBH_HCI_CAPABILITIES ARM_USBH_HCI_GetCapabilities (void)
351 \brief Get driver capabilities.
352 \return \ref ARM_USBH_HCI_CAPABILITIES
355 \fn int32_t ARM_USBH_HCI_Initialize (ARM_USBH_HCI_Interrupt_t *cb_interrupt)
356 \brief Initialize USB Host HCI (OHCI/EHCI) Interface.
357 \param[in] cb_interrupt Pointer to Interrupt Handler Routine
358 \return \ref execution_status
361 \fn int32_t ARM_USBH_HCI_Uninitialize (void)
362 \brief De-initialize USB Host HCI (OHCI/EHCI) Interface.
363 \return \ref execution_status
366 \fn int32_t ARM_USBH_HCI_PowerControl (ARM_POWER_STATE state)
367 \brief Control USB Host HCI (OHCI/EHCI) Interface Power.
368 \param[in] state Power state
369 \return \ref execution_status
372 \fn int32_t ARM_USBH_HCI_PortVbusOnOff (uint8_t port, bool vbus)
373 \brief USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.
374 \param[in] port Root HUB Port Number
378 \return \ref execution_status
382 \fn void ARM_USBH_HCI_Interrupt (void)
383 \brief USB Host HCI Interrupt Handler.
387 typedef void (*ARM_USBH_HCI_Interrupt_t) (void); ///< Pointer to Interrupt Handler Routine.
391 \brief USB Host HCI (OHCI/EHCI) Driver Capabilities.
393 typedef struct _ARM_USBH_HCI_CAPABILITIES {
394 uint32_t port_mask : 15; ///< Root HUB available Ports Mask
395 uint32_t reserved : 17; ///< Reserved (must be zero)
396 } ARM_USBH_HCI_CAPABILITIES;
400 \brief Access structure of USB Host HCI (OHCI/EHCI) Driver.
402 typedef struct _ARM_DRIVER_USBH_HCI {
403 ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_USBH_HCI_GetVersion : Get USB Host HCI (OHCI/EHCI) driver version.
404 ARM_USBH_HCI_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_USBH_HCI_GetCapabilities : Get driver capabilities.
405 int32_t (*Initialize) (ARM_USBH_HCI_Interrupt_t cb_interrupt); ///< Pointer to \ref ARM_USBH_HCI_Initialize : Initialize USB Host HCI (OHCI/EHCI) Interface.
406 int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_USBH_HCI_Uninitialize : De-initialize USB Host HCI (OHCI/EHCI) Interface.
407 int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_USBH_HCI_PowerControl : Control USB Host HCI (OHCI/EHCI) Interface Power.
408 int32_t (*PortVbusOnOff) (uint8_t port, bool vbus); ///< Pointer to \ref ARM_USBH_HCI_PortVbusOnOff : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.
409 } const ARM_DRIVER_USBH_HCI;
411 #endif /* __DOXYGEN_MW__ */
417 #endif /* DRIVER_USBH_H_ */