CMSIS-Driver  Version 2.04
Peripheral Interface for Middleware and Application Code
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
USBH Packet Information

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

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.