From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- docs/Driver/html/group__USBH__packets.html | 358 +++++++++++++++++++++++++++++ 1 file changed, 358 insertions(+) create mode 100644 docs/Driver/html/group__USBH__packets.html (limited to 'docs/Driver/html/group__USBH__packets.html') diff --git a/docs/Driver/html/group__USBH__packets.html b/docs/Driver/html/group__USBH__packets.html new file mode 100644 index 0000000..aa4a73e --- /dev/null +++ b/docs/Driver/html/group__USBH__packets.html @@ -0,0 +1,358 @@ + + + + + +USBH Packet Information +CMSIS-Driver: USBH Packet Information + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-Driver +  Version 2.6.0 +
+
Peripheral Interface for Middleware and Application Code
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Macros
+
+
USBH Packet Information
USB Host
+
+
+ +

Specify USB packet information used by the function ARM_USBH_PipeTransfer. +More...

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define ARM_USBH_PACKET_SETUP   (0x01UL << ARM_USBH_PACKET_TOKEN_Pos)
 SETUP Packet. More...
 
#define ARM_USBH_PACKET_OUT   (0x02UL << ARM_USBH_PACKET_TOKEN_Pos)
 OUT Packet. More...
 
#define ARM_USBH_PACKET_IN   (0x03UL << ARM_USBH_PACKET_TOKEN_Pos)
 IN Packet. More...
 
#define ARM_USBH_PACKET_PING   (0x04UL << ARM_USBH_PACKET_TOKEN_Pos)
 PING Packet. More...
 
#define ARM_USBH_PACKET_DATA0   (0x01UL << ARM_USBH_PACKET_DATA_Pos)
 DATA0 PID. More...
 
#define ARM_USBH_PACKET_DATA1   (0x02UL << ARM_USBH_PACKET_DATA_Pos)
 DATA1 PID. More...
 
#define ARM_USBH_PACKET_SSPLIT   (0x08UL << ARM_USBH_PACKET_SPLIT_Pos)
 SSPLIT Packet. More...
 
#define ARM_USBH_PACKET_SSPLIT_S   (0x09UL << ARM_USBH_PACKET_SPLIT_Pos)
 SSPLIT Packet: Data Start. More...
 
#define ARM_USBH_PACKET_SSPLIT_E   (0x0AUL << ARM_USBH_PACKET_SPLIT_Pos)
 SSPLIT Packet: Data End. More...
 
#define ARM_USBH_PACKET_SSPLIT_S_E   (0x0BUL << ARM_USBH_PACKET_SPLIT_Pos)
 SSPLIT Packet: Data All. More...
 
#define ARM_USBH_PACKET_CSPLIT   (0x0CUL << ARM_USBH_PACKET_SPLIT_Pos)
 CSPLIT Packet. More...
 
#define ARM_USBH_PACKET_PRE   (1UL << 12)
 PRE Token. More...
 
+

Description

+

Specify USB packet information used by the function ARM_USBH_PipeTransfer.

+

This section provides the packet information values (parameter packet) for the ARM_USBH_PipeTransfer function.

+

The following values are defined:

+

Macro Definition Documentation

+ +
+
+ + + + +
#define ARM_USBH_PACKET_SETUP   (0x01UL << ARM_USBH_PACKET_TOKEN_Pos)
+
+ +

SETUP Packet.

+

Generate SETUP transaction.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_OUT   (0x02UL << ARM_USBH_PACKET_TOKEN_Pos)
+
+ +

OUT Packet.

+

Generate OUT transaction.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_IN   (0x03UL << ARM_USBH_PACKET_TOKEN_Pos)
+
+ +

IN Packet.

+

Generate IN transaction.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_PING   (0x04UL << ARM_USBH_PACKET_TOKEN_Pos)
+
+ +

PING Packet.

+

Generate PING transaction (no data packet).

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_DATA0   (0x01UL << ARM_USBH_PACKET_DATA_Pos)
+
+ +

DATA0 PID.

+

Force DATA0 PID (Packet Identifier) for the initial data packet. When not specified than the driver provides the initial value according to the current state.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_DATA1   (0x02UL << ARM_USBH_PACKET_DATA_Pos)
+
+ +

DATA1 PID.

+

Force DATA1 PID (Packet Identifier) for the initial data packet. When not specified than the driver provides the initial value according to the current state.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_SSPLIT   (0x08UL << ARM_USBH_PACKET_SPLIT_Pos)
+
+ +

SSPLIT Packet.

+

Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. For isochronous OUT it indicates that the High-speed data is in the middle of the Full-speed data payload.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_SSPLIT_S   (0x09UL << ARM_USBH_PACKET_SPLIT_Pos)
+
+ +

SSPLIT Packet: Data Start.

+

Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. Valid only for isochronous OUT and indicates that the High-speed data is the start of the Full-speed data payload.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_SSPLIT_E   (0x0AUL << ARM_USBH_PACKET_SPLIT_Pos)
+
+ +

SSPLIT Packet: Data End.

+

Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. Valid only for isochronous OUT and indicates that the High-speed data is the end of the Full-speed data payload.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_SSPLIT_S_E   (0x0BUL << ARM_USBH_PACKET_SPLIT_Pos)
+
+ +

SSPLIT Packet: Data All.

+

Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. Valid only for isochronous OUT and indicates that the High-speed data is all of the Full-speed data payload.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_CSPLIT   (0x0CUL << ARM_USBH_PACKET_SPLIT_Pos)
+
+ +

CSPLIT Packet.

+

Used when driver does not support automatic handling of SPLIT packets and indicates Complete-Split packet.

+ +
+
+ +
+
+ + + + +
#define ARM_USBH_PACKET_PRE   (1UL << 12)
+
+ +

PRE Token.

+

Generate PRE (Preamble) for low-speed devices within a full/low-speed signaling environment.

+ +
+
+
+
+ + + + -- cgit