3.16 USB - Universal Serial Bus

• typedef void(* USB_cb_t) (void)

  Data type for the interrupt handlers called by USB. The default value is set to NULL which means that no callback function will be used.

• void USB0_Initialize (void)

  Initializes USB0.

• void USB0_TrnComplCallbackRegister (USB_cb_t cb)

  Registers a callback function handling the Interrupt Service Routine (ISR) if a Transaction Complete interrupt flag is set.

• void USB0_BusEventCallbackRegister (USB_cb_t cb)

  Registers a callback function handling the ISR if a Bus Event interrupt flag is set.

void * USB_cb_t

Data type for the interrupt handlers called by USB. The default value is set to NULL which means that no callback function will be used.

void USB0_BusEventCallbackRegister (USB_cb_t cb)

Registers a callback function handling the ISR if a Bus Event interrupt flag is set.

void USB0_Initialize (void )

Initializes USB0.

Section: USB0 APIs

void USB0_TrnComplCallbackRegister (USB_cb_t cb)

Registers a callback function handling the Interrupt Service Routine (ISR) if a Transaction Complete interrupt flag is set.

• USB Peripheral AVR DU

  This file encompasses all the register settings of the AVR DU device in the form of inline functions. It also abstracts the Read-Modify-Write loop for STATUS registers, which is required, as the hardware and software can both write into the STATUS register.

• USB Peripheral Endpoint

  API module for usb_peripheral_endpoint covering endpoint-related functions.

• USB Peripheral Read/Write

  API module for usb_peripheral covering low-level USB transaction functions.

• struct USB_CONTROL_TRANSFER_t

  The data structure for internally handling control transfers, either IN or OUT.

• bool USB_SetupIsReceived (void)

  Detects if the Setup event was received.

• bool USB_EventSOFIsReceived (void)

  Detects if the Start-of-Frame (SOF) event was received.

• void USB_EventSOFClear (void)

  Clears the SOF event.

• bool USB_EventResetIsReceived (void)

  Detects if the Reset event was received.

• void USB_EventResetClear (void)

  Clears the Reset event.

• uint8_t USB_EventOverUnderflowIsReceived (void)

  Detects if an Overflow and/or Underflow event was received.

• uint8_t USB_ControlOverUnderflowIsReceived (void)

  Detects if an Overflow and/or Underflow event was received on the control endpoints.

• void USB_EventOverUnderflowClear (void)

  Clears the Over/Underflow event.

• bool USB_EventSuspendIsReceived (void)

  Detects if a Suspend event was received.

• void USB_EventSuspendClear (void)

  Clears the Suspend event.

• bool USB_EventResumeIsReceived (void)

  Detects if a Resume event was received.

• void USB_EventResumeClear (void)

  Clears the Resume event.

• bool USB_EventStalledIsReceived (void)

  Detects if a Stalled event was received.

• void USB_EventStalledClear (void)

  Clears the Stalled event.

• void USB_BusAttach (void)

  Attaches the device to the USB bus.

• void USB_BusDetach (void)

  Detaches the device from the USB bus.

• bool USB_IsBusAttached (void)

  Checks if the device is attached to the USB bus not.

• void USB_DeviceAddressConfigure (uint8_t deviceAddress)

  Sets the device address.

• uint16_t USB_FrameNumberGet (void)

  Gets the current frame number.

• RETURN_CODE_t USB_ControlEndpointsInit (void)

  Ensures correct control endpoint initialization.

• RETURN_CODE_t USB_ControlSetupReceived (void)

  Verifies the received control setup.

• RETURN_CODE_t USB_ControlTransactionComplete (USB_PIPE_t pipe)

  Handles completed transactions on the control endpoints. Checks and verifies data OUT, data IN, ZLP OUT and ZLP IN.

• RETURN_CODE_t USB_ControlTransferZLP (uint8_t direction)

  Sends ZLP OUT and ZLP IN transactions on the control endpoints.

• RETURN_CODE_t USB_ControlTransferReset (void)

  Ensures correct control transfer reset.

• RETURN_CODE_t USB_ControlTransferDataSet (uint8_t *dataPtr, uint16_t dataSize)

  Updates the transfer data pointer and size in ControlTransfer.

• RETURN_CODE_t USB_ControlTransferDataWriteBuffer (uint8_t *dataPtr, uint8_t dataSize)

  Copies data to the transfer buffer and sets the transfer data pointer and size in ControlTransfer.

• void USB_ControlEndOfRequestCallbackRegister (USB_SETUP_ENDOFREQUEST_CALLBACK_t callback)

  Sets the callback for end of a control request.

• void USB_ControlProcessSetupCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

  Sets the callback for the setup processing.

• void USB_ControlOverUnderRunCallbackRegister (USB_SETUP_OVERUNDERRUN_CALLBACK_t callback)

  Sets the callback for a control overrun or underrun.

• RETURN_CODE_t USB_ControlProcessOverUnderflow (uint8_t overunderflow)

  Handles the control Over/Underflow events.

• RETURN_CODE_t USB_HandleEventStalled (USB_PIPE_t pipe)

  Handles the Stall events.

• void USB_PeripheralInitialize (void)

  Enables the peripheral and the frame number, enables and resets FIFO, sets the endpoint table address and max endpoints.

• void USB_PeripheralDisable (void)

  Disables the USB peripheral and aborts any ongoing transaction.

• static ALWAYS_INLINE uint16_t USB_FrameNumGet (void)

  Gets the current frame number.

void USB_BusAttach (void )

Attaches the device to the USB bus.

void USB_BusDetach (void )

Detaches the device from the USB bus.

void USB_ControlEndOfRequestCallbackRegister (USB_SETUP_ENDOFREQUEST_CALLBACK_t callback)

Sets the callback for end of a control request.

RETURN_CODE_t USB_ControlEndpointsInit (void )

Ensures correct control endpoint initialization.

uint8_t USB_ControlOverUnderflowIsReceived (void )

Detects if an Overflow and/or Underflow event was received on the control endpoints.

void USB_ControlOverUnderRunCallbackRegister (USB_SETUP_OVERUNDERRUN_CALLBACK_t callback)

Sets the callback for a control overrun or underrun.

RETURN_CODE_t USB_ControlProcessOverUnderflow (uint8_t overunderflow)

Handles the control Over/Underflow events.

void USB_ControlProcessSetupCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

Sets the callback for the setup processing.

RETURN_CODE_t USB_ControlSetupReceived (void )

Verifies the received control setup.

RETURN_CODE_t USB_ControlTransactionComplete (USB_PIPE_t pipe)

Handles completed transactions on the control endpoints. Checks and verifies data OUT, data IN, ZLP OUT and ZLP IN.

RETURN_CODE_t USB_ControlTransferDataSet (uint8_t * dataPtr, uint16_t dataSize)

Updates the transfer data pointer and size in ControlTransfer.

RETURN_CODE_t USB_ControlTransferDataWriteBuffer (uint8_t * dataPtr, uint8_t dataSize)

Copies data to the transfer buffer and sets the transfer data pointer and size in ControlTransfer.

RETURN_CODE_t USB_ControlTransferReset (void )

Ensures correct control transfer reset.

RETURN_CODE_t USB_ControlTransferZLP (uint8_t direction)

Sends ZLP OUT and ZLP IN transactions on the control endpoints.

void USB_DeviceAddressConfigure (uint8_t deviceAddress)

Sets the device address.

void USB_EventOverUnderflowClear (void )

Clears the Over/Underflow event.

uint8_t USB_EventOverUnderflowIsReceived (void )

Detects if an Overflow and/or Underflow event was received.

void USB_EventResetClear (void )

Clears the Reset event.

bool USB_EventResetIsReceived (void )

Detects if the Reset event was received.

void USB_EventResumeClear (void )

Clears the Resume event.

bool USB_EventResumeIsReceived (void )

Detects if a Resume event was received.

void USB_EventSOFClear (void )

Clears the SOF event.

bool USB_EventSOFIsReceived (void )

Detects if the Start-of-Frame (SOF) event was received.

void USB_EventStalledClear (void )

Clears the Stalled event.

bool USB_EventStalledIsReceived (void )

Detects if a Stalled event was received.

void USB_EventSuspendClear (void )

Clears the Suspend event.

bool USB_EventSuspendIsReceived (void )

Detects if a Suspend event was received.

uint16_t USB_FrameNumberGet (void )

Gets the current frame number.

static ALWAYS_INLINE uint16_t USB_FrameNumGet (void )[static]

Gets the current frame number.

RETURN_CODE_t USB_HandleEventStalled (USB_PIPE_t pipe)

Handles the Stall events.

bool USB_IsBusAttached (void )

Checks if the device is attached to the USB bus not.

void USB_PeripheralDisable (void )

Disables the USB peripheral and aborts any ongoing transaction.

void USB_PeripheralInitialize (void )

Enables the peripheral and the frame number, enables and resets FIFO, sets the endpoint table address and max endpoints.

bool USB_SetupIsReceived (void )

Detects if the Setup event was received.

• struct USB_ENDPOINT_TABLE_struct

  Represents the endpoint configuration table based on the number of endpoints in use. The table data structure is defined by USB_EP_TABLE_struct in the device header file, modified to support configuration of size from USB_EP_NUM.

• struct USB_PIPE_TRANSFER_struct

  Represents a transfer created for a pipe, either IN or OUT.

• #define ALWAYS_INLINE __attribute__((always_inline)) inline

  Alias that makes always inline function definitions more readable.

• static ALWAYS_INLINE void WaitUntilRMWDone (void)

  Waits until a Read-Modify-Write operation is done. This blocking wait operation is expected to complete within 14 clock cycles.

• static ALWAYS_INLINE void USB_EndPointOutDisable (uint8_t endpointAddress)

  Disables the OUT endpoint with the given address.

• static ALWAYS_INLINE void USB_EndPointInDisable (uint8_t endpointAddress)

  Disables the IN endpoint with the given address.

• static ALWAYS_INLINE bool USB_EndPointOutIsEnabled (uint8_t endpointAddress)

  Checks if the OUT endpoint at the given address is enabled.

• static ALWAYS_INLINE bool USB_EndPointInIsEnabled (uint8_t endpointAddress)

  Checks if the IN endpoint at the given address is enabled.

• static ALWAYS_INLINE uint8_t USB_EndPointOutTypeConfigGet (uint8_t endpointAddress)

  Gets the OUT endpoint configuration at the given address.

• static ALWAYS_INLINE uint8_t USB_EndPointInTypeConfigGet (uint8_t endpointAddress)

  Gets the IN endpoint configuration at the given address.

• static ALWAYS_INLINE void USB_EndpointOutControlSet (uint8_t endpointAddress, uint8_t value)

  Sets endpoint control OUT.

• static ALWAYS_INLINE void USB_EndpointInControlSet (uint8_t endpointAddress, uint8_t value)

  Sets endpoint control IN.

• static ALWAYS_INLINE void USB_EndpointOutStatusClear (uint8_t endpointAddress)

  Clears OUT endpoint status.

• static ALWAYS_INLINE void USB_EndpointInStatusClear (uint8_t endpointAddress)

  Clears IN endpoint status.

• static ALWAYS_INLINE void USB_EndpointOutDefaultSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)

  Sets the endpoint size for a default type OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInDefaultSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)

  Sets the endpoint size for a default type IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutIsoSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)

  Sets the endpoint size for an isochronous OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInIsoSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)

  Sets the endpoint size for an isochronous IN endpoint.

• static ALWAYS_INLINE uint8_t USB_EndpointOutDefaultSizeGet (uint8_t endpointAddress)

  Gets the size of a default type OUT endpoint.

• static ALWAYS_INLINE uint8_t USB_EndpointInDefaultSizeGet (uint8_t endpointAddress)

  Gets the size of a default type IN endpoint.

• static ALWAYS_INLINE uint8_t USB_EndpointOutIsoSizeGet (uint8_t endpointAddress)

  Gets the size of an isochronous OUT endpoint.

• static ALWAYS_INLINE uint8_t USB_EndpointInIsoSizeGet (uint8_t endpointAddress)

  Gets the size of an isochronous IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutTransactionCompleteInterruptEnable (uint8_t endpointAddress)

  Enables transaction complete interrupt for the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInTransactionCompleteInterruptEnable (uint8_t endpointAddress)

  Enables transaction complete interrupt for the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutTransactionCompleteInterruptDisable (uint8_t endpointAddress)

  Disables transaction complete interrupt for the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInTransactionCompleteDisable (uint8_t endpointAddress)

  Disables transaction complete interrupt for the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutMultipktEnable (uint8_t endpointAddress)

  Enables multipacket for the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInMultipktEnable (uint8_t endpointAddress)

  Enables multipacket for the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutMultipktDisable (uint8_t endpointAddress)

  Disables multipacket for the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInMultipktDisable (uint8_t endpointAddress)

  Disables multipacket for the specified IN endpoint.

• static ALWAYS_INLINE bool USB_EndpointOutMultipktIsEnabled (uint8_t endpointAddress)

  Checks if multipacket is enabled on the specified OUT endpoint.

• static ALWAYS_INLINE bool USB_EndpointInMultipktIsEnabled (uint8_t endpointAddress)

  Checks if multipacket is enabled on the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutAzlpEnable (uint8_t endpointAddress)

  Enables Auto Zero Length Packet (AZLP) on the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInAlzpEnable (uint8_t endpointAddress)

  Enables AZLP on the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutAzlpDisable (uint8_t endpointAddress)

  Disables AZLP on the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInAzlpDisable (uint8_t endpointAddress)

  Disables AZLP on the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutStall (uint8_t endpointAddress)

  Stalls the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInStall (uint8_t endpointAddress)

  Stalls the specified IN endpoint.

• static ALWAYS_INLINE void USB_EndpointOutStallClear (uint8_t endpointAddress)

  Stops stalling the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInStallClear (uint8_t endpointAddress)

  Stops stalling the specified IN endpoint.

• static ALWAYS_INLINE bool USB_EndpointOutIsStalled (uint8_t endpointAddress)

  Checks if the specified OUT endpoint is stalled.

• static ALWAYS_INLINE bool USB_EndpointInIsStalled (uint8_t endpointAddress)

  Checks if the specified IN endpoint is stalled.

• static ALWAYS_INLINE void USB_EndpointOutStallAck (uint8_t endpointAddress)

  Acknowledges that an OUT endpoint is stalled and Clears the USB STATUS register.

• static ALWAYS_INLINE void USB_EndpointInStallAck (uint8_t endpointAddress)

  Acknowledges that an IN endpoint is stalled and Clears the USB STATUS register.

• static ALWAYS_INLINE void USB_EndpointOutNAKSet (uint8_t endpointAddress)

  Sets OUT endpoint status to NAK.

• static ALWAYS_INLINE void USB_EndpointInNAKSet (uint8_t endpointAddress)

  Sets IN endpoint status to NAK.

• static ALWAYS_INLINE void USB_EndpointOutNAKClear (uint8_t endpointAddress)

  Clears the USB NAK status from the OUT endpoint STATUS register.

• static ALWAYS_INLINE void USB_EndpointInNAKClear (uint8_t endpointAddress)

  Clears the USB NAK status from the IN endpoint STATUS register.

• static ALWAYS_INLINE bool USB_EndpointOutNAKIsSet (uint8_t endpointAddress)

  Checks the OUT endpoint STATUS register for the NAK status.

• static ALWAYS_INLINE bool USB_EndpointInNAKIsSet (uint8_t endpointAddress)

  Checks the OUT endpoint STATUS register for the NAK status.

• static ALWAYS_INLINE void USB_EndpointOutTransactionCompleteAck (uint8_t endpointAddress)

  Acknowledges the transaction complete status on a specified OUT endpoint and Clears the USB STATUS register.

• static ALWAYS_INLINE void USB_EndpointInTransactionCompleteAck (uint8_t endpointAddress)

  Acknowledges the transaction complete status on a specified IN endpoint and Clears the USB STATUS register.

• static ALWAYS_INLINE bool USB_EndpointOutTransactionIsComplete (uint8_t endpointAddress)

  Checks if the USB OUT endpoint has the Transaction Complete status.

• static ALWAYS_INLINE bool USB_EndpointInTransactionIsComplete (uint8_t endpointAddress)

  Checks if the USB IN endpoint has the Transaction Complete status.

• static ALWAYS_INLINE void USB_EndpointOutSetupReceivedAck (uint8_t endpointAddress)

  Acknowledges the Setup Received status on a specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInSetupCompleteAck (uint8_t endpointAddress)

  Acknowledges the Setup Received status on a specified IN endpoint.

• static ALWAYS_INLINE bool USB_EndpointOutSetupIsReceived (uint8_t endpointAddress)

  Checks if the USB OUT endpoint has the Setup Received status.

• static ALWAYS_INLINE bool USB_EndpointInSetupIsReceived (uint8_t endpointAddress)

  Checks if the USB IN endpoint has the Setup Received status.

• static ALWAYS_INLINE void USB_EndpointOutDataToggleSet (uint8_t endpointAddress)

  Sets OUT endpoint data toggle.

• static ALWAYS_INLINE void USB_EndpointInDataToggleSet (uint8_t endpointAddress)

  Sets IN endpoint data toggle.

• static ALWAYS_INLINE void USB_EndpointOutDataToggleClear (uint8_t endpointAddress)

  Clears OUT endpoint data toggle.

• static ALWAYS_INLINE void USB_EndpointInDataToggleClear (uint8_t endpointAddress)

  Clears IN endpoint data toggle.

• static ALWAYS_INLINE bool USB_EndpointOutDataToggleIsSet (uint8_t endpointAddress)

  Checks if data toggle is set on the specified OUT endpoint.

• static ALWAYS_INLINE bool USB_EndpointInDataToggleIsSet (uint8_t endpointAddress)

  Checks if data toggle is set on the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointOutBufferSet (uint8_t endpointAddress, uint8_t *bufAddress)

  Sets endpoint buffer OUT.

• static ALWAYS_INLINE void USB_EndpointInBufferSet (uint8_t endpointAddress, uint8_t *bufAddress)

  Sets endpoint buffer IN.

• static ALWAYS_INLINE void USB_NumberBytesToSendSet (uint8_t endpointAddress, uint16_t numberBytes)

  Sets how many bytes of data are intended to be sent from the specified endpoint.

• static ALWAYS_INLINE uint16_t USB_NumberBytesToSendGet (uint8_t endpointAddress)

  Reads out the CNT register to know how many bytes of data are intended to be sent from the specified endpoint.

• static ALWAYS_INLINE void USB_NumberBytesToSendReset (uint8_t endpointAddress)

  Clears the CNT register to tell the peripheral no data is intended to be sent from the specified endpoint.

• static ALWAYS_INLINE uint16_t USB_NumberBytesSentGet (uint8_t endpointAddress)

  Reads out how many bytes have been sent from the specified endpoint.

• static ALWAYS_INLINE void USB_NumberBytesSentReset (uint8_t endpointAddress)

  Clears the MCNT register that keeps track of how many bytes of data have been sent.

• static ALWAYS_INLINE void USB_NumberBytesToReceiveSet (uint8_t endpointAddress, uint16_t numberBytes)

  Sets how many bytes of data are expected to be received on a specified endpoint.

• static ALWAYS_INLINE uint16_t USB_NumberBytesToReceiveGet (uint8_t endpointAddress)

  Gets how many bytes of data are expected to be received on a specified endpoint.

• static ALWAYS_INLINE void USB_NumberBytesToReceiveReset (uint8_t endpointAddress)

  Clears the MCNT register to tell the peripheral no data is intended to be received on the specified endpoint.

• static ALWAYS_INLINE uint16_t USB_NumberBytesReceivedGet (uint8_t endpointAddress)

  Gets how many bytes of data have been received on a specified endpoint.

• static ALWAYS_INLINE void USB_NumberBytesReceivedReset (uint8_t endpointAddress)

  Resets the counter that counts amount of bytes of data received on a specific endpoint.

• static ALWAYS_INLINE bool USB_EndpointOutOverUnderflowIsSet (uint8_t endpointAddress)

  Checks if OUT endpoint has overflowed.

• static ALWAYS_INLINE bool USB_EndpointInOverUnderflowIsSet (uint8_t endpointAddress)

  Checks if IN endpoint has underflowed.

• static ALWAYS_INLINE void USB_EndpointOutOverUnderflowAck (uint8_t endpointAddress)

  Acknowledges overflow on the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInOverUnderflowAck (uint8_t endpointAddress)

  Acknowledges underflow on the specified IN endpoint.

• static ALWAYS_INLINE bool USB_EndpointOutCRCHasFailed (uint8_t endpointAddress)

  Checks if the specified OUT endpoint has a Cyclic Redundancy Check (CRC) failure.

• static ALWAYS_INLINE bool USB_EndpointInCRCHasFailed (uint8_t endpointAddress)

  Checks if the specified IN endpoint has a CRC failure.

• static ALWAYS_INLINE void USB_EndpointOutCRCAck (uint8_t endpointAddress)

  Acknowledges a CRC failure on the specified OUT endpoint.

• static ALWAYS_INLINE void USB_EndpointInCRCAck (uint8_t endpointAddress)

  Acknowledges a CRC failure on the specified IN endpoint.

• static ALWAYS_INLINE void USB_GlobalNAKEnable (void)

  Enables global NAK.

• static ALWAYS_INLINE void USB_GlobalNAKDisable (void)

  Disables global NAK.

• static ALWAYS_INLINE bool USB_GlobalNAKIsEnable (void)

  Checks the global NAK setting.

• static ALWAYS_INLINE void USB_ConnectionAttach (void)

  Tells the USB peripheral to attach.

• static ALWAYS_INLINE void USB_ConnectionDetach (void)

  Tells the USB peripheral to detach.

• static ALWAYS_INLINE bool USB_ConnectionIsAttach (void)

  Checks if the USB connection is attached.

• static ALWAYS_INLINE void USB_Enable (void)

  Enables the USB peripheral.

• static ALWAYS_INLINE void USB_Disable (void)

  Disables the USB peripheral.

• static ALWAYS_INLINE bool USB_IsEnable (void)

  Checks if the USB peripheral is enabled.

• static ALWAYS_INLINE void USB_FifoEnable (void)

  Enables USB FIFO.

• static ALWAYS_INLINE void USB_FifoDisable (void)

  Disables USB FIFO.

• static ALWAYS_INLINE bool USB_FifoIsEnable (void)

  Checks if USB FIFO has been enabled.

• static ALWAYS_INLINE void USB_AutomaticGlobalNAKEnable (void)

  Enables automatic global NAK for the USB peripheral.

• static ALWAYS_INLINE void USB_AutomaticGlobalNAKDisable (void)

  Disables automatic global NAK for the USB peripheral.

• static ALWAYS_INLINE bool USB_AutomaticGlobalNAKIsEnable (void)

  Checks if automatic global NAK has been enabled.

• static ALWAYS_INLINE void USB_FrameNumEnable (void)

  Enables storing the last SOF token frame number in FRAMENUM. This is a device-specific function.

• static ALWAYS_INLINE void USB_FrameNumDisable (void)

  Disables storing the last SOF token frame number in FRAMENUM. This is a device-specific function.

• static ALWAYS_INLINE bool USB_FrameNumIsEnable (void)

  Checks if storing of the last SOF token frame number is enabled. This is a device-specific function.

• static ALWAYS_INLINE void USB_MaxEndpointsSet (uint8_t maxEndpoint)

  Sets maximum number of endpoint addresses used by the USB peripheral.

• static ALWAYS_INLINE void USB_MaxEndpointsReset (void)

  Clears the USB endpoint maximum, setting the maximum endpoint to EP0.

• static ALWAYS_INLINE uint8_t USB_MaxEndpointsGet (void)

  Checks what the maximum number of endpoint addresses is.

• static ALWAYS_INLINE void USB_EndpointTableAddressSet (USB_EP_PAIR_t *endpointTableAddress)

  Sets the address of the endpoint table. This is a device-specific function.

• static ALWAYS_INLINE void USB_EndpointTableAddressReset (void)

  Sets the address of the endpoint table to 0. This is a device-specific function.

• static ALWAYS_INLINE uint16_t USB_EndpointTableAddressGet (void)

  Gets the address of the endpoint table. This is a device-specific function.

• static ALWAYS_INLINE void USB_FifoReadPointerReset (void)

  Resets the read FIFO pointer. This is a device-specific function.

• static ALWAYS_INLINE int8_t USB_FifoReadPointerGet (void)

  Gets the read FIFO pointer. This is a device-specific function.

• static ALWAYS_INLINE void USB_FifoWritePointerReset (void)

  Resets the write FIFO pointer. This is a device-specific function.

• static ALWAYS_INLINE int8_t USB_FifoWritePointerGet (void)

  Gets the write FIFO pointer. This is a device-specific function.

• static ALWAYS_INLINE void USB_DeviceAddressSet (uint8_t usbAddress)

  Sets the device address.

• static ALWAYS_INLINE void USB_DeviceAddressReset (void)

  Resets the device address.

• static ALWAYS_INLINE uint8_t USB_DeviceAddressGet (void)

  Gets the device address.

• static ALWAYS_INLINE void USB_UpstreamResumeEnable (void)

  Enables an upstream resume to be initated.

• static ALWAYS_INLINE bool USB_UpstreamResumeIsEnable (void)

  Checks if upstream resume is enabled, but not yet initiated.

• static ALWAYS_INLINE uint8_t USB_BusStateGet (void)

  Gets the USB bus state.

• static ALWAYS_INLINE bool USB_BusStateIs (uint8_t bus_state_bm)

  Checks if the USB bus has any specific status flags set.

• static ALWAYS_INLINE void USB_SOFInterruptEnable (void)

  Enables the USB Start-Of-Frame interrupt.

• static ALWAYS_INLINE void USB_SOFInterruptDisable (void)

  Disables the USB Start-Of-Frame interrupt.

• static ALWAYS_INLINE void USB_SOFInterruptClear (void)

  Clears the USB Start-Of-Frame Interrupt flag.

• static ALWAYS_INLINE bool USB_SOFInterruptIs (void)

  Checks if the USB Start-Of-Frame interrupt has been triggered.

• static ALWAYS_INLINE void USB_SuspendInterruptEnable (void)

  Enables the USB Suspend interrupt.

• static ALWAYS_INLINE void USB_SuspendInterruptDisable (void)

  Disables the USB Suspend interrupt.

• static ALWAYS_INLINE void USB_SuspendInterruptClear (void)

  Clears the USB Suspend Interrupt flag.

• static ALWAYS_INLINE bool USB_SuspendInterruptIs (void)

  Checks if the USB Suspend interrupt has been triggered.

• static ALWAYS_INLINE void USB_ResumeInterruptEnable (void)

  Enables the USB Resume interrupt.

• static ALWAYS_INLINE void USB_ResumeInterruptDisable (void)

  Disables the USB Resume interrupt.

• static ALWAYS_INLINE void USB_ResumeInterruptClear (void)

  Clears the USB Resume Interrupt flag.

• static ALWAYS_INLINE bool USB_ResumeInterruptIs (void)

  Checks if the USB Resume interrupt has been triggered.

• static ALWAYS_INLINE void USB_ResetInterruptEnable (void)

  Enables the USB Reset interrupt.

• static ALWAYS_INLINE void USB_ResetInterruptDisable (void)

  Disables the USB Reset interrupt.

• static ALWAYS_INLINE void USB_ResetInterruptClear (void)

  Clears the USB Reset Interrupt flag.

• static ALWAYS_INLINE bool USB_ResetInterruptIs (void)

  Checks if the USB Reset interrupt has been triggered.

• static ALWAYS_INLINE void USB_StalledInterruptEnable (void)

  Enables the USB Stalled interrupt.

• static ALWAYS_INLINE void USB_StalledInterruptDisable (void)

  Disables the USB Stalled interrupt.

• static ALWAYS_INLINE void USB_StalledInterruptClear (void)

  Clears the USB Stalled Interrupt flag.

• static ALWAYS_INLINE bool USB_StalledInterruptIs (void)

  Checks if the USB Stalled interrupt has been triggered.

• static ALWAYS_INLINE void USB_UnderflowInterruptEnable (void)

  Enables the USB Underflow interrupt.

• static ALWAYS_INLINE void USB_UnderflowInterruptDisable (void)

  Disables the USB Underflow interrupt.

• static ALWAYS_INLINE void USB_UnderflowInterruptClear (void)

  Clears the USB Underflow Interrupt flag.

• static ALWAYS_INLINE bool USB_UnderflowInterruptIs (void)

  Checks if an Underflow interrupt has been triggered.

• static ALWAYS_INLINE void USB_OverflowInterruptEnable (void)

  Enables the USB Overflow interrupt.

• static ALWAYS_INLINE void USB_OverflowInterruptDisable (void)

  Disables the USB Overflow interrupt.

• static ALWAYS_INLINE void USB_OverflowInterruptClear (void)

  Clears the USB Overflow Interrupt flag.

• static ALWAYS_INLINE bool USB_OverflowInterruptIs (void)

  Checks if an Overflow interrupt has been triggered.

• static ALWAYS_INLINE void USB_TransactionCompleteInterruptEnable (void)

  Enables the USB Transaction Complete interrupt.

• static ALWAYS_INLINE void USB_TransactionCompleteInterruptDisable (void)

  Disables the USB Transaction Complete interrupt.

• static ALWAYS_INLINE void USB_TransactionCompleteInterruptAck (void)

  Clears the USB Transaction Complete Interrupt flag.

• static ALWAYS_INLINE bool USB_TransactionCompleteInterruptIs (void)

  Checks if a Transaction Complete interrupt has been triggered.

• static ALWAYS_INLINE bool USB_ReadModifyWriteInterruptIs (void)

  Checks if the USB Read-Modify-Write Interrupt is enabled.

• static ALWAYS_INLINE void USB_GlobalNAKDoneInterruptEnable (void)

  Enables the USB Global NAK Done interrupt.

• static ALWAYS_INLINE void USB_GlobalNAKDoneInterruptDisable (void)

  Disables the USB Global NAK Done interrupt.

• static ALWAYS_INLINE void USB_GlobalNAKDoneInterruptAck (void)

  Clears the USB Global NAK Done Interrupt flag.

• static ALWAYS_INLINE bool USB_GlobalNAKDoneInterruptIs (void)

  Checks if the USB Global NAK Done interrupt has been triggered.

• static ALWAYS_INLINE void USB_SetupInterruptEnable (void)

  Enables the USB Setup interrupt.

• static ALWAYS_INLINE void USB_SetupInterruptDisable (void)

  Disables the USB Setup interrupt.

• static ALWAYS_INLINE void USB_SetupInterruptClear (void)

  Clears the USB Setup Interrupt flag.

• static ALWAYS_INLINE bool USB_SetupInterruptIs (void)

  Checks if a USB Setup interrupt has been triggered.

• static ALWAYS_INLINE void USB_InterruptFlagsClear (void)

  Clears all the USB Interrupt flags.

#define ALWAYS_INLINE __attribute__((always_inline)) inline

Alias that makes always inline function definitions more readable.

static ALWAYS_INLINE void USB_AutomaticGlobalNAKDisable (void )[static]

Disables automatic global NAK for the USB peripheral.

static ALWAYS_INLINE void USB_AutomaticGlobalNAKEnable (void )[static]

Enables automatic global NAK for the USB peripheral.

static ALWAYS_INLINE bool USB_AutomaticGlobalNAKIsEnable (void )[static]

Checks if automatic global NAK has been enabled.

static ALWAYS_INLINE uint8_t USB_BusStateGet (void )[static]

Gets the USB bus state.

static ALWAYS_INLINE bool USB_BusStateIs (uint8_t bus_state_bm)[static]

Checks if the USB bus has any specific status flags set.

static ALWAYS_INLINE void USB_ConnectionAttach (void )[static]

Tells the USB peripheral to attach.

static ALWAYS_INLINE void USB_ConnectionDetach (void )[static]

Tells the USB peripheral to detach.

static ALWAYS_INLINE bool USB_ConnectionIsAttach (void )[static]

Checks if the USB connection is attached.

static ALWAYS_INLINE uint8_t USB_DeviceAddressGet (void )[static]

Gets the device address.

static ALWAYS_INLINE void USB_DeviceAddressReset (void )[static]

Resets the device address.

static ALWAYS_INLINE void USB_DeviceAddressSet (uint8_t usbAddress)[static]

Sets the device address.

static ALWAYS_INLINE void USB_Disable (void )[static]

Disables the USB peripheral.

static ALWAYS_INLINE void USB_Enable (void )[static]

Enables the USB peripheral.

static ALWAYS_INLINE void USB_EndpointInAlzpEnable (uint8_t endpointAddress)[static]

Enables AZLP on the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInAzlpDisable (uint8_t endpointAddress)[static]

Disables AZLP on the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInBufferSet (uint8_t endpointAddress, uint8_t * bufAddress)[static]

Sets endpoint buffer IN.

MISRA C:2012 Deviation Advisory: misra-c2012- 11.4  

static ALWAYS_INLINE void USB_EndpointInControlSet (uint8_t endpointAddress, uint8_t value)[static]

Sets endpoint control IN.

static ALWAYS_INLINE void USB_EndpointInCRCAck (uint8_t endpointAddress)[static]

Acknowledges a CRC failure on the specified IN endpoint.

static ALWAYS_INLINE bool USB_EndpointInCRCHasFailed (uint8_t endpointAddress)[static]

Checks if the specified IN endpoint has a CRC failure.

static ALWAYS_INLINE void USB_EndpointInDataToggleClear (uint8_t endpointAddress)[static]

Clears IN endpoint data toggle.

static ALWAYS_INLINE bool USB_EndpointInDataToggleIsSet (uint8_t endpointAddress)[static]

Checks if data toggle is set on the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointInDataToggleSet (uint8_t endpointAddress)[static]

Sets IN endpoint data toggle.

static ALWAYS_INLINE uint8_t USB_EndpointInDefaultSizeGet (uint8_t endpointAddress)[static]

Gets the size of a default type IN endpoint.

static ALWAYS_INLINE void USB_EndpointInDefaultSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)[static]

Sets the endpoint size for a default type IN endpoint.

static ALWAYS_INLINE void USB_EndPointInDisable (uint8_t endpointAddress)[static]

Disables the IN endpoint with the given address.

static ALWAYS_INLINE bool USB_EndPointInIsEnabled (uint8_t endpointAddress)[static]

Checks if the IN endpoint at the given address is enabled.

static ALWAYS_INLINE uint8_t USB_EndpointInIsoSizeGet (uint8_t endpointAddress)[static]

Gets the size of an isochronous IN endpoint.

static ALWAYS_INLINE void USB_EndpointInIsoSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)[static]

Sets the endpoint size for an isochronous IN endpoint.

static ALWAYS_INLINE bool USB_EndpointInIsStalled (uint8_t endpointAddress)[static]

Checks if the specified IN endpoint is stalled.

static ALWAYS_INLINE void USB_EndpointInMultipktDisable (uint8_t endpointAddress)[static]

Disables multipacket for the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInMultipktEnable (uint8_t endpointAddress)[static]

Enables multipacket for the specified IN endpoint.

static ALWAYS_INLINE bool USB_EndpointInMultipktIsEnabled (uint8_t endpointAddress)[static]

Checks if multipacket is enabled on the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInNAKClear (uint8_t endpointAddress)[static]

Clears the USB NAK status from the IN endpoint STATUS register.

static ALWAYS_INLINE bool USB_EndpointInNAKIsSet (uint8_t endpointAddress)[static]

Checks the OUT endpoint STATUS register for the NAK status.

static ALWAYS_INLINE void USB_EndpointInNAKSet (uint8_t endpointAddress)[static]

Sets IN endpoint status to NAK.

static ALWAYS_INLINE void USB_EndpointInOverUnderflowAck (uint8_t endpointAddress)[static]

Acknowledges underflow on the specified IN endpoint.

static ALWAYS_INLINE bool USB_EndpointInOverUnderflowIsSet (uint8_t endpointAddress)[static]

Checks if IN endpoint has underflowed.

static ALWAYS_INLINE void USB_EndpointInSetupCompleteAck (uint8_t endpointAddress)[static]

Acknowledges the Setup Received status on a specified IN endpoint.

static ALWAYS_INLINE bool USB_EndpointInSetupIsReceived (uint8_t endpointAddress)[static]

Checks if the USB IN endpoint has the Setup Received status.

static ALWAYS_INLINE void USB_EndpointInStall (uint8_t endpointAddress)[static]

Stalls the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInStallAck (uint8_t endpointAddress)[static]

Acknowledges that an IN endpoint is stalled and Clears the USB STATUS register.

static ALWAYS_INLINE void USB_EndpointInStallClear (uint8_t endpointAddress)[static]

Stops stalling the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInStatusClear (uint8_t endpointAddress)[static]

Clears IN endpoint status.

static ALWAYS_INLINE void USB_EndpointInTransactionCompleteAck (uint8_t endpointAddress)[static]

Acknowledges the transaction complete status on a specified IN endpoint and Clears the USB STATUS register.

static ALWAYS_INLINE void USB_EndpointInTransactionCompleteDisable (uint8_t endpointAddress)[static]

Disables transaction complete interrupt for the specified IN endpoint.

static ALWAYS_INLINE void USB_EndpointInTransactionCompleteInterruptEnable (uint8_t endpointAddress)[static]

Enables transaction complete interrupt for the specified IN endpoint.

static ALWAYS_INLINE bool USB_EndpointInTransactionIsComplete (uint8_t endpointAddress)[static]

Checks if the USB IN endpoint has the Transaction Complete status.

static ALWAYS_INLINE uint8_t USB_EndPointInTypeConfigGet (uint8_t endpointAddress)[static]

Gets the IN endpoint configuration at the given address.

static ALWAYS_INLINE void USB_EndpointOutAzlpDisable (uint8_t endpointAddress)[static]

Disables AZLP on the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutAzlpEnable (uint8_t endpointAddress)[static]

Enables Auto Zero Length Packet (AZLP) on the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutBufferSet (uint8_t endpointAddress, uint8_t * bufAddress)[static]

Sets endpoint buffer OUT.

MISRA C:2012 Deviation Advisory: misra-c2012- 11.4  

static ALWAYS_INLINE void USB_EndpointOutControlSet (uint8_t endpointAddress, uint8_t value)[static]

Sets endpoint control OUT.

static ALWAYS_INLINE void USB_EndpointOutCRCAck (uint8_t endpointAddress)[static]

Acknowledges a CRC failure on the specified OUT endpoint.

static ALWAYS_INLINE bool USB_EndpointOutCRCHasFailed (uint8_t endpointAddress)[static]

Checks if the specified OUT endpoint has a Cyclic Redundancy Check (CRC) failure.

static ALWAYS_INLINE void USB_EndpointOutDataToggleClear (uint8_t endpointAddress)[static]

Clears OUT endpoint data toggle.

static ALWAYS_INLINE bool USB_EndpointOutDataToggleIsSet (uint8_t endpointAddress)[static]

Checks if data toggle is set on the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutDataToggleSet (uint8_t endpointAddress)[static]

Sets OUT endpoint data toggle.

static ALWAYS_INLINE uint8_t USB_EndpointOutDefaultSizeGet (uint8_t endpointAddress)[static]

Gets the size of a default type OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutDefaultSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)[static]

Sets the endpoint size for a default type OUT endpoint.

static ALWAYS_INLINE void USB_EndPointOutDisable (uint8_t endpointAddress)[static]

Disables the OUT endpoint with the given address.

static ALWAYS_INLINE bool USB_EndPointOutIsEnabled (uint8_t endpointAddress)[static]

Checks if the OUT endpoint at the given address is enabled.

static ALWAYS_INLINE uint8_t USB_EndpointOutIsoSizeGet (uint8_t endpointAddress)[static]

Gets the size of an isochronous OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutIsoSizeSet (uint8_t endpointAddress, uint8_t endpointSizeConfig)[static]

Sets the endpoint size for an isochronous OUT endpoint.

static ALWAYS_INLINE bool USB_EndpointOutIsStalled (uint8_t endpointAddress)[static]

Checks if the specified OUT endpoint is stalled.

static ALWAYS_INLINE void USB_EndpointOutMultipktDisable (uint8_t endpointAddress)[static]

Disables multipacket for the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutMultipktEnable (uint8_t endpointAddress)[static]

Enables multipacket for the specified OUT endpoint.

static ALWAYS_INLINE bool USB_EndpointOutMultipktIsEnabled (uint8_t endpointAddress)[static]

Checks if multipacket is enabled on the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutNAKClear (uint8_t endpointAddress)[static]

Clears the USB NAK status from the OUT endpoint STATUS register.

static ALWAYS_INLINE bool USB_EndpointOutNAKIsSet (uint8_t endpointAddress)[static]

Checks the OUT endpoint STATUS register for the NAK status.

static ALWAYS_INLINE void USB_EndpointOutNAKSet (uint8_t endpointAddress)[static]

Sets OUT endpoint status to NAK.

static ALWAYS_INLINE void USB_EndpointOutOverUnderflowAck (uint8_t endpointAddress)[static]

Acknowledges overflow on the specified OUT endpoint.

static ALWAYS_INLINE bool USB_EndpointOutOverUnderflowIsSet (uint8_t endpointAddress)[static]

Checks if OUT endpoint has overflowed.

static ALWAYS_INLINE bool USB_EndpointOutSetupIsReceived (uint8_t endpointAddress)[static]

Checks if the USB OUT endpoint has the Setup Received status.

static ALWAYS_INLINE void USB_EndpointOutSetupReceivedAck (uint8_t endpointAddress)[static]

Acknowledges the Setup Received status on a specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutStall (uint8_t endpointAddress)[static]

Stalls the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutStallAck (uint8_t endpointAddress)[static]

Acknowledges that an OUT endpoint is stalled and Clears the USB STATUS register.

static ALWAYS_INLINE void USB_EndpointOutStallClear (uint8_t endpointAddress)[static]

Stops stalling the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutStatusClear (uint8_t endpointAddress)[static]

Clears OUT endpoint status.

static ALWAYS_INLINE void USB_EndpointOutTransactionCompleteAck (uint8_t endpointAddress)[static]

Acknowledges the transaction complete status on a specified OUT endpoint and Clears the USB STATUS register.

static ALWAYS_INLINE void USB_EndpointOutTransactionCompleteInterruptDisable (uint8_t endpointAddress)[static]

Disables transaction complete interrupt for the specified OUT endpoint.

static ALWAYS_INLINE void USB_EndpointOutTransactionCompleteInterruptEnable (uint8_t endpointAddress)[static]

Enables transaction complete interrupt for the specified OUT endpoint.

static ALWAYS_INLINE bool USB_EndpointOutTransactionIsComplete (uint8_t endpointAddress)[static]

Checks if the USB OUT endpoint has the Transaction Complete status.

static ALWAYS_INLINE uint8_t USB_EndPointOutTypeConfigGet (uint8_t endpointAddress)[static]

Gets the OUT endpoint configuration at the given address.

static ALWAYS_INLINE uint16_t USB_EndpointTableAddressGet (void )[static]

Gets the address of the endpoint table. This is a device-specific function.

static ALWAYS_INLINE void USB_EndpointTableAddressReset (void )[static]

Sets the address of the endpoint table to 0. This is a device-specific function.

static ALWAYS_INLINE void USB_EndpointTableAddressSet (USB_EP_PAIR_t * endpointTableAddress)[static]

Sets the address of the endpoint table. This is a device-specific function.

static ALWAYS_INLINE void USB_FifoDisable (void )[static]

Disables USB FIFO.

This is a device-specific function.

static ALWAYS_INLINE void USB_FifoEnable (void )[static]

Enables USB FIFO.

This is a device-specific function.

static ALWAYS_INLINE bool USB_FifoIsEnable (void )[static]

Checks if USB FIFO has been enabled.

This is a device-specific function.

static ALWAYS_INLINE int8_t USB_FifoReadPointerGet (void )[static]

Gets the read FIFO pointer. This is a device-specific function.

static ALWAYS_INLINE void USB_FifoReadPointerReset (void )[static]

Resets the read FIFO pointer. This is a device-specific function.

static ALWAYS_INLINE int8_t USB_FifoWritePointerGet (void )[static]

Gets the write FIFO pointer. This is a device-specific function.

static ALWAYS_INLINE void USB_FifoWritePointerReset (void )[static]

Resets the write FIFO pointer. This is a device-specific function.

static ALWAYS_INLINE void USB_FrameNumDisable (void )[static]

Disables storing the last SOF token frame number in FRAMENUM. This is a device-specific function.

static ALWAYS_INLINE void USB_FrameNumEnable (void )[static]

Enables storing the last SOF token frame number in FRAMENUM. This is a device-specific function.

static ALWAYS_INLINE bool USB_FrameNumIsEnable (void )[static]

Checks if storing of the last SOF token frame number is enabled. This is a device-specific function.

static ALWAYS_INLINE void USB_GlobalNAKDisable (void )[static]

Disables global NAK.

static ALWAYS_INLINE void USB_GlobalNAKDoneInterruptAck (void )[static]

Clears the USB Global NAK Done Interrupt flag.

static ALWAYS_INLINE void USB_GlobalNAKDoneInterruptDisable (void )[static]

Disables the USB Global NAK Done interrupt.

static ALWAYS_INLINE void USB_GlobalNAKDoneInterruptEnable (void )[static]

Enables the USB Global NAK Done interrupt.

static ALWAYS_INLINE bool USB_GlobalNAKDoneInterruptIs (void )[static]

Checks if the USB Global NAK Done interrupt has been triggered.

static ALWAYS_INLINE void USB_GlobalNAKEnable (void )[static]

Enables global NAK.

static ALWAYS_INLINE bool USB_GlobalNAKIsEnable (void )[static]

Checks the global NAK setting.

static ALWAYS_INLINE void USB_InterruptFlagsClear (void )[static]

Clears all the USB Interrupt flags.

static ALWAYS_INLINE bool USB_IsEnable (void )[static]

Checks if the USB peripheral is enabled.

static ALWAYS_INLINE uint8_t USB_MaxEndpointsGet (void )[static]

Checks what the maximum number of endpoint addresses is.

static ALWAYS_INLINE void USB_MaxEndpointsReset (void )[static]

Clears the USB endpoint maximum, setting the maximum endpoint to EP0.

static ALWAYS_INLINE void USB_MaxEndpointsSet (uint8_t maxEndpoint)[static]

Sets maximum number of endpoint addresses used by the USB peripheral.

static ALWAYS_INLINE uint16_t USB_NumberBytesReceivedGet (uint8_t endpointAddress)[static]

Gets how many bytes of data have been received on a specified endpoint.

static ALWAYS_INLINE void USB_NumberBytesReceivedReset (uint8_t endpointAddress)[static]

Resets the counter that counts amount of bytes of data received on a specific endpoint.

static ALWAYS_INLINE uint16_t USB_NumberBytesSentGet (uint8_t endpointAddress)[static]

Reads out how many bytes have been sent from the specified endpoint.

static ALWAYS_INLINE void USB_NumberBytesSentReset (uint8_t endpointAddress)[static]

Clears the MCNT register that keeps track of how many bytes of data have been sent.

static ALWAYS_INLINE uint16_t USB_NumberBytesToReceiveGet (uint8_t endpointAddress)[static]

Gets how many bytes of data are expected to be received on a specified endpoint.

static ALWAYS_INLINE void USB_NumberBytesToReceiveReset (uint8_t endpointAddress)[static]

Clears the MCNT register to tell the peripheral no data is intended to be received on the specified endpoint.

static ALWAYS_INLINE void USB_NumberBytesToReceiveSet (uint8_t endpointAddress, uint16_t numberBytes)[static]

Sets how many bytes of data are expected to be received on a specified endpoint.

static ALWAYS_INLINE uint16_t USB_NumberBytesToSendGet (uint8_t endpointAddress)[static]

Reads out the CNT register to know how many bytes of data are intended to be sent from the specified endpoint.

static ALWAYS_INLINE void USB_NumberBytesToSendReset (uint8_t endpointAddress)[static]

Clears the CNT register to tell the peripheral no data is intended to be sent from the specified endpoint.

static ALWAYS_INLINE void USB_NumberBytesToSendSet (uint8_t endpointAddress, uint16_t numberBytes)[static]

Sets how many bytes of data are intended to be sent from the specified endpoint.

static ALWAYS_INLINE void USB_OverflowInterruptClear (void )[static]

Clears the USB Overflow Interrupt flag.

static ALWAYS_INLINE void USB_OverflowInterruptDisable (void )[static]

Disables the USB Overflow interrupt.

static ALWAYS_INLINE void USB_OverflowInterruptEnable (void )[static]

Enables the USB Overflow interrupt.

static ALWAYS_INLINE bool USB_OverflowInterruptIs (void )[static]

Checks if an Overflow interrupt has been triggered.

static ALWAYS_INLINE bool USB_ReadModifyWriteInterruptIs (void )[static]

Checks if the USB Read-Modify-Write Interrupt is enabled.

static ALWAYS_INLINE void USB_ResetInterruptClear (void )[static]

Clears the USB Reset Interrupt flag.

static ALWAYS_INLINE void USB_ResetInterruptDisable (void )[static]

Disables the USB Reset interrupt.

static ALWAYS_INLINE void USB_ResetInterruptEnable (void )[static]

Enables the USB Reset interrupt.

static ALWAYS_INLINE bool USB_ResetInterruptIs (void )[static]

Checks if the USB Reset interrupt has been triggered.

static ALWAYS_INLINE void USB_ResumeInterruptClear (void )[static]

Clears the USB Resume Interrupt flag.

static ALWAYS_INLINE void USB_ResumeInterruptDisable (void )[static]

Disables the USB Resume interrupt.

static ALWAYS_INLINE void USB_ResumeInterruptEnable (void )[static]

Enables the USB Resume interrupt.

static ALWAYS_INLINE bool USB_ResumeInterruptIs (void )[static]

Checks if the USB Resume interrupt has been triggered.

static ALWAYS_INLINE void USB_SetupInterruptClear (void )[static]

Clears the USB Setup Interrupt flag.

static ALWAYS_INLINE void USB_SetupInterruptDisable (void )[static]

Disables the USB Setup interrupt.

static ALWAYS_INLINE void USB_SetupInterruptEnable (void )[static]

Enables the USB Setup interrupt.

static ALWAYS_INLINE bool USB_SetupInterruptIs (void )[static]

Checks if a USB Setup interrupt has been triggered.

static ALWAYS_INLINE void USB_SOFInterruptClear (void )[static]

Clears the USB Start-Of-Frame Interrupt flag.

static ALWAYS_INLINE void USB_SOFInterruptDisable (void )[static]

Disables the USB Start-Of-Frame interrupt.

static ALWAYS_INLINE void USB_SOFInterruptEnable (void )[static]

Enables the USB Start-Of-Frame interrupt.

static ALWAYS_INLINE bool USB_SOFInterruptIs (void )[static]

Checks if the USB Start-Of-Frame interrupt has been triggered.

static ALWAYS_INLINE void USB_StalledInterruptClear (void )[static]

Clears the USB Stalled Interrupt flag.

static ALWAYS_INLINE void USB_StalledInterruptDisable (void )[static]

Disables the USB Stalled interrupt.

static ALWAYS_INLINE void USB_StalledInterruptEnable (void )[static]

Enables the USB Stalled interrupt.

static ALWAYS_INLINE bool USB_StalledInterruptIs (void )[static]

Checks if the USB Stalled interrupt has been triggered.

static ALWAYS_INLINE void USB_SuspendInterruptClear (void )[static]

Clears the USB Suspend Interrupt flag.

static ALWAYS_INLINE void USB_SuspendInterruptDisable (void )[static]

Disables the USB Suspend interrupt.

static ALWAYS_INLINE void USB_SuspendInterruptEnable (void )[static]

Enables the USB Suspend interrupt.

static ALWAYS_INLINE bool USB_SuspendInterruptIs (void )[static]

Checks if the USB Suspend interrupt has been triggered.

static ALWAYS_INLINE void USB_TransactionCompleteInterruptAck (void )[static]

Clears the USB Transaction Complete Interrupt flag.

static ALWAYS_INLINE void USB_TransactionCompleteInterruptDisable (void )[static]

Disables the USB Transaction Complete interrupt.

static ALWAYS_INLINE void USB_TransactionCompleteInterruptEnable (void )[static]

Enables the USB Transaction Complete interrupt.

static ALWAYS_INLINE bool USB_TransactionCompleteInterruptIs (void )[static]

Checks if a Transaction Complete interrupt has been triggered.

static ALWAYS_INLINE void USB_UnderflowInterruptClear (void )[static]

Clears the USB Underflow Interrupt flag.

static ALWAYS_INLINE void USB_UnderflowInterruptDisable (void )[static]

Disables the USB Underflow interrupt.

static ALWAYS_INLINE void USB_UnderflowInterruptEnable (void )[static]

Enables the USB Underflow interrupt.

static ALWAYS_INLINE bool USB_UnderflowInterruptIs (void )[static]

Checks if an Underflow interrupt has been triggered.

static ALWAYS_INLINE void USB_UpstreamResumeEnable (void )[static]

Enables an upstream resume to be initated.

static ALWAYS_INLINE bool USB_UpstreamResumeIsEnable (void )[static]

Checks if upstream resume is enabled, but not yet initiated.

static ALWAYS_INLINE void WaitUntilRMWDone (void )[static]

Waits until a Read-Modify-Write operation is done. This blocking wait operation is expected to complete within 14 clock cycles.

• #define IsPowerOfTwo(number) ((0u != (number)) && (((number) & ((number)-1u)) == 0u))

  Algorithm to detect if a given number is a power of two. A number is a power of two if it has exactly one '1' in its binary representation. This is true if subtracting '1' from the number and doing an AND operation on the result with the number itself returns 0.

• RETURN_CODE_t USB_EndpointConfigure (USB_PIPE_t pipe, uint16_t endpointSize, USB_ENDPOINT_t endpointType)

  Configures the endpoint with the desired settings using the Control and Status Register. Used to set up an endpoint before using it in an application. Sets up all the control register settings by looking up the usb_config.h file and clears the count registers.

• RETURN_CODE_t USB_EndpointDisable (USB_PIPE_t pipe)

  Disables the endpoint by setting the endpoint type to 0x00.

• uint16_t USB_EndpointSizeGet (USB_PIPE_t pipe)

  Helper function to return the endpoint size.

• USB_ENDPOINT_t USB_EndpointTypeGet (USB_PIPE_t pipe)

  Helper function to return the endpoint type.

• RETURN_CODE_t USB_EndpointStall (USB_PIPE_t pipe)

  Helps stall an endpoint when a command received from the host is invalid or unrecognizable. Used if the host sends data that is not supported by the device.

• RETURN_CODE_t USB_EndpointStallClear (USB_PIPE_t pipe)

  Helps clear the Stall condition after the device has recovered from an unsupported command from the host. Used to reset stall before the next USB transfer. Used when the host issues a clear HALT/Feature request to reset stall.

• bool USB_EndpointIsStalled (USB_PIPE_t pipe)

  Helper function to return the endpoint Stall condition.

• RETURN_CODE_t USB_EndpointStalledConditionAck (USB_PIPE_t pipe)

  Acknowledges the stall status condition by clearing the Stall Status bit. Used to clear the Stall Status bit after a stall has been detected.

• RETURN_CODE_t USB_DataToggleSet (USB_PIPE_t pipe)

  Sets the Data Toggle bit on an endpoint which is used to ensure correct data sequence. Only used if hardware data toggling is not available. After a successful transaction, toggle the Data Toggle bit. For SETUP transactions, ensure that the SETUP stage clears the Data Toggle bit, while the data stage and status stage set the Data Toggle bit.

• RETURN_CODE_t USB_DataToggleClear (USB_PIPE_t pipe)

  Clears the Data Toggle bit on an endpoint which is used to ensure correct data sequence. Only used if hardware data toggling is not available. After a successful transaction, toggle the Data Toggle bit. For SETUP transactions, ensure that the SETUP stage clears the Data Toggle bit, while the data stage and status stage set the Data Toggle bit.

• RETURN_CODE_t USB_DataToggle (USB_PIPE_t pipe)

  Toggles the Data Toggle bit on an endpoint which is used to ensure correct data sequence. Only used if hardware data toggling is not available. After a successful transaction, toggle the Data Toggle bit. For SETUP transactions, ensure that the SETUP stage clears the Data Toggle bit, while the data stage and status stage set the Data Toggle bit.

• RETURN_CODE_t ConvertEndpointSizeToMask (uint16_t endpointSize, USB_ENDPOINT_t endpointType, uint8_t *endpointMaskPtr)

  Converts an endpoint size in number of bytes into a register setting. Converts the endpoint size bit mask based on the EP_BUFSIZE setting of the endpoint control register.

• RETURN_CODE_t EndpointBufferSet (USB_PIPE_t pipe, uint8_t *bufAddress)

  Configures the endpoint data buffer to a location in RAM for the next transaction.

• USB_ENDPOINT_TABLE_t endpointTable

  SRAM tables for the FIFO and endpoint registers, as well as the FRAMENUM register. Represents the endpoint configuration table based on the number of endpoints in use. This line instantiates an object using the data structure type.

#define IsPowerOfTwo( number) ((0u != (number)) && (((number) & ((number)-1u)) == 0u))

Algorithm to detect if a given number is a power of two. A number is a power of two if it has exactly one '1' in its binary representation. This is true if subtracting '1' from the number and doing an AND operation on the result with the number itself returns 0.

RETURN_CODE_t ConvertEndpointSizeToMask (uint16_t endpointSize, USB_ENDPOINT_t endpointType, uint8_t * endpointMaskPtr)

Converts an endpoint size in number of bytes into a register setting. Converts the endpoint size bit mask based on the EP_BUFSIZE setting of the endpoint control register.

RETURN_CODE_t EndpointBufferSet (USB_PIPE_t pipe, uint8_t * bufAddress)

Configures the endpoint data buffer to a location in RAM for the next transaction.

RETURN_CODE_t USB_DataToggle (USB_PIPE_t pipe)

Toggles the Data Toggle bit on an endpoint which is used to ensure correct data sequence. Only used if hardware data toggling is not available. After a successful transaction, toggle the Data Toggle bit. For SETUP transactions, ensure that the SETUP stage clears the Data Toggle bit, while the data stage and status stage set the Data Toggle bit.

RETURN_CODE_t USB_DataToggleClear (USB_PIPE_t pipe)

Clears the Data Toggle bit on an endpoint which is used to ensure correct data sequence. Only used if hardware data toggling is not available. After a successful transaction, toggle the Data Toggle bit. For SETUP transactions, ensure that the SETUP stage clears the Data Toggle bit, while the data stage and status stage set the Data Toggle bit.

RETURN_CODE_t USB_DataToggleSet (USB_PIPE_t pipe)

Sets the Data Toggle bit on an endpoint which is used to ensure correct data sequence. Only used if hardware data toggling is not available. After a successful transaction, toggle the Data Toggle bit. For SETUP transactions, ensure that the SETUP stage clears the Data Toggle bit, while the data stage and status stage set the Data Toggle bit.

RETURN_CODE_t USB_EndpointConfigure (USB_PIPE_t pipe, uint16_t endpointSize, USB_ENDPOINT_t endpointType)

Configures the endpoint with the desired settings using the Control and Status Register. Used to set up an endpoint before using it in an application. Sets up all the control register settings by looking up the usb_config.h file and clears the count registers.

RETURN_CODE_t USB_EndpointDisable (USB_PIPE_t pipe)

Disables the endpoint by setting the endpoint type to 0x00.

bool USB_EndpointIsStalled (USB_PIPE_t pipe)

Helper function to return the endpoint Stall condition.

uint16_t USB_EndpointSizeGet (USB_PIPE_t pipe)

Helper function to return the endpoint size.

RETURN_CODE_t USB_EndpointStall (USB_PIPE_t pipe)

Helps stall an endpoint when a command received from the host is invalid or unrecognizable. Used if the host sends data that is not supported by the device.

RETURN_CODE_t USB_EndpointStallClear (USB_PIPE_t pipe)

Helps clear the Stall condition after the device has recovered from an unsupported command from the host. Used to reset stall before the next USB transfer. Used when the host issues a clear HALT/Feature request to reset stall.

RETURN_CODE_t USB_EndpointStalledConditionAck (USB_PIPE_t pipe)

Acknowledges the stall status condition by clearing the Stall Status bit. Used to clear the Stall Status bit after a stall has been detected.

USB_ENDPOINT_t USB_EndpointTypeGet (USB_PIPE_t pipe)

Helper function to return the endpoint type.

USB_ENDPOINT_TABLE_t endpointTable

SRAM tables for the FIFO and endpoint registers, as well as the FRAMENUM register. Represents the endpoint configuration table based on the number of endpoints in use. This line instantiates an object using the data structure type.

• RETURN_CODE_t USB_TransactionStart (USB_PIPE_t pipe)

  Starts sending or receiving data on an endpoint by clearing BUSNACK. Used as a final step while setting up a transaction on the bus.

• RETURN_CODE_t USB_TransactionAbort (USB_PIPE_t pipe)

  Aborts the next transaction on an endpoint by setting BUSNACK. Used to stop exchanging data on an endpoint. The device will start NAKing requests from the host after calling this API.

• RETURN_CODE_t USB_TransactionCompleteAck (USB_PIPE_t pipe)

  Acknowledges the Transaction Complete status condition by clearing the Transaction Complete status bit. Used to clear the Transaction Complete status bit after a transaction has successfully completed.

• bool USB_TransactionIsCompleted (void)

  Helper function to return the endpoint transaction complete condition.

• RETURN_CODE_t USB_TransactionCompletedPipeGet (USB_PIPE_t *pipe)

  Returns the pipe address and direction for the latest completed transaction.

• RETURN_CODE_t USB_PipeReset (USB_PIPE_t pipe)

  Resets the pipe.

• USB_TRANSFER_STATUS_t USB_PipeStatusGet (USB_PIPE_t pipe)

  Gets the current status of pipe.

• bool USB_PipeStatusIsBusy (USB_PIPE_t pipe)

  Checks if the pipe status is busy.

• void USB_PipeDataPtrSet (USB_PIPE_t pipe, uint8_t *dataPtr)

  Configures the pointer for the data transfer in a given pipe.

• uint8_t * USB_PipeDataPtrGet (USB_PIPE_t pipe)

  Gets the current data pointer for a given pipe.

• void USB_PipeDataToTransferSizeSet (USB_PIPE_t pipe, uint16_t dataSize)

  Sets the size of pipe data to transfer.

• uint16_t USB_PipeDataToTransferSizeGet (USB_PIPE_t pipe)

  Gets the size of pipe data to transfer.

• uint16_t USB_PipeDataTransferredSizeGet (USB_PIPE_t pipe)

  Gets the size of the transferred pipe data.

• void USB_PipeDataTransferredSizeSet (USB_PIPE_t pipe, uint16_t dataSize)

  Sets the size of the transferred pipe data.

• void USB_PipeDataTransferredSizeReset (USB_PIPE_t pipe)

  Resets the size of transferred pipe data.

• void USB_PipeTransferZLP_Enable (USB_PIPE_t pipe)

  Enables a ZLP on a transfer. It is enabled by default if the AZLP static config is enabled for the pipe.

• void USB_PipeTransferEndCallbackRegister (USB_PIPE_t pipe, USB_TRANSFER_END_CALLBACK_t callback)

  Sets the callback for transfer end.

• void USB_PipeTransferEndCallback (USB_PIPE_t pipe)

  Calls the callback for transfer end.

• RETURN_CODE_t USB_InTransactionRun (USB_PIPE_t pipe)

  Checks the correctness of IN transactions and runs them.

• RETURN_CODE_t USB_OutTransactionRun (USB_PIPE_t pipe)

  Checks the correctness OUT transactions and runs them.

• RETURN_CODE_t USB_PipeTransactionComplete (USB_PIPE_t pipe)

  Handles completed IN and OUT transactions. Processes the completed transaction and either completes the transfer or runs the next transaction. Will call the pipe transferEndCallback at the end of transfer, if configured.

RETURN_CODE_t USB_InTransactionRun (USB_PIPE_t pipe)

Checks the correctness of IN transactions and runs them.

RETURN_CODE_t USB_OutTransactionRun (USB_PIPE_t pipe)

Checks the correctness OUT transactions and runs them.

uint8_t* USB_PipeDataPtrGet (USB_PIPE_t pipe)

Gets the current data pointer for a given pipe.

void USB_PipeDataPtrSet (USB_PIPE_t pipe, uint8_t * dataPtr)

Configures the pointer for the data transfer in a given pipe.

uint16_t USB_PipeDataToTransferSizeGet (USB_PIPE_t pipe)

Gets the size of pipe data to transfer.

void USB_PipeDataToTransferSizeSet (USB_PIPE_t pipe, uint16_t dataSize)

Sets the size of pipe data to transfer.

uint16_t USB_PipeDataTransferredSizeGet (USB_PIPE_t pipe)

Gets the size of the transferred pipe data.

void USB_PipeDataTransferredSizeReset (USB_PIPE_t pipe)

Resets the size of transferred pipe data.

void USB_PipeDataTransferredSizeSet (USB_PIPE_t pipe, uint16_t dataSize)

Sets the size of the transferred pipe data.