LPCOpen Platform  v1.03
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
Endpoint Packet Management (LPC18xx)
Endpoint Packet Management

Detailed Description

Endpoint packet management definitions for the LPC18xx architecture.

Functions, macros, variables, enums and types related to packet management of endpoints.

Functions

static uint8_t Endpoint_GetBusyBanks (void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT
 Retrieves the number of busy banks in the currently selected endpoint, which have been queued for transmission via the Endpoint_ClearIN() command, or are awaiting acknowledgement via the Endpoint_ClearOUT() command.
 
static void Endpoint_AbortPendingIN (void)
 Aborts all pending IN transactions on the currently selected endpoint, once the bank has been queued for transmission to the host via Endpoint_ClearIN(). This function will terminate all queued transactions, resetting the endpoint banks ready for a new packet.
 
static bool Endpoint_IsINReady (uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
 Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 
static bool Endpoint_IsOUTReceived (uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
 Determines if the selected OUT endpoint has received new packet from the host.
 
static bool Endpoint_IsSETUPReceived (uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
 Determines if the current CONTROL type endpoint has received a SETUP packet.
 
static void Endpoint_ClearSETUP (uint8_t corenum) ATTR_ALWAYS_INLINE
 Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the endpoint for the next packet.
 
static void Endpoint_ClearIN (uint8_t corenum) ATTR_ALWAYS_INLINE
 Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.
 
static void Endpoint_ClearOUT (uint8_t corenum) ATTR_ALWAYS_INLINE
 Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.
 
static void Endpoint_StallTransaction (uint8_t corenum) ATTR_ALWAYS_INLINE
 Stalls the current endpoint, indicating to the host that a logical problem occurred with the indicated endpoint and that the current transfer sequence should be aborted. This provides a way for devices to indicate invalid commands to the host so that the current transfer can be aborted and the host can begin its own recovery sequence.
 
static void Endpoint_ClearStall (uint8_t corenum) ATTR_ALWAYS_INLINE
 Clears the STALL condition on the currently selected endpoint.
 
static bool Endpoint_IsStalled (uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
 Determines if the currently selected endpoint is stalled, false otherwise.
 

Function Documentation

static void Endpoint_AbortPendingIN ( void  )
inlinestatic

Aborts all pending IN transactions on the currently selected endpoint, once the bank has been queued for transmission to the host via Endpoint_ClearIN(). This function will terminate all queued transactions, resetting the endpoint banks ready for a new packet.

Returns
Nothing.

Definition at line 235 of file Endpoint_LPC17xx.h.

static void Endpoint_ClearIN ( uint8_t  corenum)
inlinestatic

Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Nothing.

Definition at line 549 of file Endpoint_LPC18xx.h.

static void Endpoint_ClearOUT ( uint8_t  corenum)
inlinestatic

Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Nothing.

Definition at line 572 of file Endpoint_LPC18xx.h.

static void Endpoint_ClearSETUP ( uint8_t  corenum)
inlinestatic

Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the endpoint for the next packet.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Nothing.
Note
This is not applicable for non CONTROL type endpoints.

Definition at line 531 of file Endpoint_LPC18xx.h.

static void Endpoint_ClearStall ( uint8_t  corenum)
inlinestatic

Clears the STALL condition on the currently selected endpoint.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Nothing.

Definition at line 616 of file Endpoint_LPC18xx.h.

static uint8_t Endpoint_GetBusyBanks ( void  )
inlinestatic

Retrieves the number of busy banks in the currently selected endpoint, which have been queued for transmission via the Endpoint_ClearIN() command, or are awaiting acknowledgement via the Endpoint_ClearOUT() command.

Returns
Total number of busy banks in the selected endpoint.

Definition at line 222 of file Endpoint_LPC17xx.h.

static bool Endpoint_IsINReady ( uint8_t  corenum)
inlinestatic

Determines if the selected IN endpoint is ready for a new packet to be sent to the host.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Boolean true if the current endpoint is ready for an IN packet, false otherwise.

Definition at line 480 of file Endpoint_LPC18xx.h.

static bool Endpoint_IsOUTReceived ( uint8_t  corenum)
inlinestatic

Determines if the selected OUT endpoint has received new packet from the host.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Boolean true if current endpoint is has received an OUT packet, false otherwise.

Definition at line 497 of file Endpoint_LPC18xx.h.

static bool Endpoint_IsSETUPReceived ( uint8_t  corenum)
inlinestatic

Determines if the current CONTROL type endpoint has received a SETUP packet.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Boolean true if the selected endpoint has received a SETUP packet, false otherwise.

Definition at line 514 of file Endpoint_LPC18xx.h.

static bool Endpoint_IsStalled ( uint8_t  corenum)
inlinestatic

Determines if the currently selected endpoint is stalled, false otherwise.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Boolean true if the currently selected endpoint is stalled, false otherwise.

Definition at line 632 of file Endpoint_LPC18xx.h.

static void Endpoint_StallTransaction ( uint8_t  corenum)
inlinestatic

Stalls the current endpoint, indicating to the host that a logical problem occurred with the indicated endpoint and that the current transfer sequence should be aborted. This provides a way for devices to indicate invalid commands to the host so that the current transfer can be aborted and the host can begin its own recovery sequence.

The currently selected endpoint remains stalled until either the Endpoint_ClearStall() macro is called, or the host issues a CLEAR FEATURE request to the device for the currently selected endpoint.

Parameters
corenum: ID Number of USB Core to be processed.
Returns
Nothing.