mirror of
https://github.com/mfulz/qmk_firmware.git
synced 2025-10-31 13:22:31 +01:00
893 lines
34 KiB
C
893 lines
34 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2010.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.lufa-lib.org
|
|
*/
|
|
|
|
/*
|
|
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
|
|
Permission to use, copy, modify, distribute, and sell this
|
|
software and its documentation for any purpose is hereby granted
|
|
without fee, provided that the above copyright notice appear in
|
|
all copies and that both that the copyright notice and this
|
|
permission notice and warranty disclaimer appear in supporting
|
|
documentation, and that the name of the author not be used in
|
|
advertising or publicity pertaining to distribution of the
|
|
software without specific, written prior permission.
|
|
|
|
The author disclaim all warranties with regard to this
|
|
software, including all implied warranties of merchantability
|
|
and fitness. In no event shall the author be liable for any
|
|
special, indirect or consequential damages or any damages
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
in an action of contract, negligence or other tortious action,
|
|
arising out of or in connection with the use or performance of
|
|
this software.
|
|
*/
|
|
|
|
/** \file
|
|
* \brief USB device endpoint management definitions.
|
|
*
|
|
* This file contains structures, function prototypes and macros related to the management of the device's
|
|
* data endpoints when the library is initialized in USB device mode.
|
|
*
|
|
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
|
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
|
*/
|
|
|
|
/** \ingroup Group_EndpointManagement
|
|
* @defgroup Group_EndpointRW Endpoint Data Reading and Writing
|
|
*
|
|
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
|
|
*/
|
|
|
|
/** \ingroup Group_EndpointRW
|
|
* @defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
|
|
*
|
|
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
|
* from and to endpoints.
|
|
*/
|
|
|
|
/** \ingroup Group_EndpointManagement
|
|
* @defgroup Group_EndpointPacketManagement Endpoint Packet Management
|
|
*
|
|
* Functions, macros, variables, enums and types related to packet management of endpoints.
|
|
*/
|
|
|
|
/** \ingroup Group_USB
|
|
* @defgroup Group_EndpointManagement Endpoint Management
|
|
*
|
|
* Functions, macros and enums related to endpoint management when in USB Device mode. This
|
|
* module contains the endpoint management macros, as well as endpoint interrupt and data
|
|
* send/receive functions for various data types.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#ifndef __ENDPOINT_H__
|
|
#define __ENDPOINT_H__
|
|
|
|
/* Includes: */
|
|
#include <avr/io.h>
|
|
#include <stdbool.h>
|
|
|
|
#include "../../../Common/Common.h"
|
|
#include "../HighLevel/USBTask.h"
|
|
#include "USBInterrupt.h"
|
|
|
|
/* Enable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Preprocessor Checks: */
|
|
#if !defined(__INCLUDE_FROM_USB_DRIVER)
|
|
#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
|
|
#endif
|
|
|
|
/* Private Interface - For use in library only: */
|
|
#if !defined(__DOXYGEN__)
|
|
/* Macros: */
|
|
#define _ENDPOINT_GET_MAXSIZE(EPIndex) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)
|
|
#define _ENDPOINT_GET_MAXSIZE2(EPDetails) _ENDPOINT_GET_MAXSIZE3(EPDetails)
|
|
#define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks) (MaxSize)
|
|
|
|
#define _ENDPOINT_GET_BANKS(EPIndex) _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)
|
|
#define _ENDPOINT_GET_BANKS2(EPDetails) _ENDPOINT_GET_BANKS3(EPDetails)
|
|
#define _ENDPOINT_GET_BANKS3(MaxSize, Banks) (Banks)
|
|
|
|
#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
|
|
#define ENDPOINT_DETAILS_MAXEP 7
|
|
|
|
#define ENDPOINT_DETAILS_EP0 64, 2
|
|
#define ENDPOINT_DETAILS_EP1 256, 2
|
|
#define ENDPOINT_DETAILS_EP2 64, 2
|
|
#define ENDPOINT_DETAILS_EP3 64, 2
|
|
#define ENDPOINT_DETAILS_EP4 64, 2
|
|
#define ENDPOINT_DETAILS_EP5 64, 2
|
|
#define ENDPOINT_DETAILS_EP6 64, 2
|
|
#else
|
|
#define ENDPOINT_DETAILS_MAXEP 5
|
|
|
|
#define ENDPOINT_DETAILS_EP0 64, 2
|
|
#define ENDPOINT_DETAILS_EP1 64, 1
|
|
#define ENDPOINT_DETAILS_EP2 64, 1
|
|
#define ENDPOINT_DETAILS_EP3 64, 2
|
|
#define ENDPOINT_DETAILS_EP4 64, 2
|
|
#endif
|
|
|
|
/* Inline Functions: */
|
|
static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
|
|
ATTR_ALWAYS_INLINE;
|
|
static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
|
|
{
|
|
uint8_t MaskVal = 0;
|
|
uint16_t CheckBytes = 8;
|
|
|
|
while (CheckBytes < Bytes)
|
|
{
|
|
MaskVal++;
|
|
CheckBytes <<= 1;
|
|
}
|
|
|
|
return (MaskVal << EPSIZE0);
|
|
}
|
|
|
|
/* Function Prototypes: */
|
|
void Endpoint_ClearEndpoints(void);
|
|
bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
|
|
const uint8_t UECFG0XData,
|
|
const uint8_t UECFG1XData);
|
|
|
|
#endif
|
|
|
|
/* Public Interface - May be used in end-application: */
|
|
/* Macros: */
|
|
/** \name Endpoint Direction Masks */
|
|
//@{
|
|
/** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
|
|
* should be initialized in the OUT direction - i.e. data flows from host to device.
|
|
*/
|
|
#define ENDPOINT_DIR_OUT (0 << EPDIR)
|
|
|
|
/** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
|
|
* should be initialized in the IN direction - i.e. data flows from device to host.
|
|
*/
|
|
#define ENDPOINT_DIR_IN (1 << EPDIR)
|
|
//@}
|
|
|
|
/** \name Endpoint Bank Mode Masks */
|
|
//@{
|
|
/** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
|
|
* that the endpoint should have one single bank, which requires less USB FIFO memory but results
|
|
* in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
|
|
* bank at the one time.
|
|
*/
|
|
#define ENDPOINT_BANK_SINGLE (0 << EPBK0)
|
|
|
|
/** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
|
|
* that the endpoint should have two banks, which requires more USB FIFO memory but results
|
|
* in faster transfers as one USB device (the AVR or the host) can access one bank while the other
|
|
* accesses the second bank.
|
|
*/
|
|
#define ENDPOINT_BANK_DOUBLE (1 << EPBK0)
|
|
//@}
|
|
|
|
/** Endpoint address for the default control endpoint, which always resides in address 0. This is
|
|
* defined for convenience to give more readable code when used with the endpoint macros.
|
|
*/
|
|
#define ENDPOINT_CONTROLEP 0
|
|
|
|
#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
|
|
/** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
|
|
* value in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
|
|
*/
|
|
#define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
|
|
#endif
|
|
|
|
/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
|
|
* numerical address in the device.
|
|
*/
|
|
#define ENDPOINT_EPNUM_MASK 0x07
|
|
|
|
/** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
|
|
* direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
|
|
*/
|
|
#define ENDPOINT_EPDIR_MASK 0x80
|
|
|
|
/** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
|
|
* bank size in the device.
|
|
*/
|
|
#define ENDPOINT_EPSIZE_MASK 0x7F
|
|
|
|
/** Maximum size in bytes of a given endpoint.
|
|
*
|
|
* \param[in] EPIndex Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
|
|
*/
|
|
#define ENDPOINT_MAX_SIZE(EPIndex) _ENDPOINT_GET_MAXSIZE(EPIndex)
|
|
|
|
/** Indicates the total number of banks supported by the given endpoint.
|
|
*
|
|
* \param[in] EPIndex Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
|
|
*/
|
|
#define ENDPOINT_BANKS_SUPPORTED(EPIndex) _ENDPOINT_GET_BANKS(EPIndex)
|
|
|
|
#if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
|
|
/** Total number of endpoints (including the default control endpoint at address 0) which may
|
|
* be used in the device. Different USB AVR models support different amounts of endpoints,
|
|
* this value reflects the maximum number of endpoints for the currently selected AVR model.
|
|
*/
|
|
#define ENDPOINT_TOTAL_ENDPOINTS ENDPOINT_DETAILS_MAXEP
|
|
#else
|
|
#define ENDPOINT_TOTAL_ENDPOINTS 1
|
|
#endif
|
|
|
|
/* Enums: */
|
|
/** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
|
|
*
|
|
* \ingroup Group_EndpointRW
|
|
*/
|
|
enum Endpoint_WaitUntilReady_ErrorCodes_t
|
|
{
|
|
ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */
|
|
ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream
|
|
* transfer by the host or device.
|
|
*/
|
|
ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while
|
|
* waiting for the endpoint to become ready.
|
|
*/
|
|
ENDPOINT_READYWAIT_BusSuspended = 3, /**< The USB bus has been suspended by the host and
|
|
* no USB endpoint traffic can occur until the bus
|
|
* has resumed.
|
|
*/
|
|
ENDPOINT_READYWAIT_Timeout = 4, /**< The host failed to accept or send the next packet
|
|
* within the software timeout period set by the
|
|
* \ref USB_STREAM_TIMEOUT_MS macro.
|
|
*/
|
|
};
|
|
|
|
/* Inline Functions: */
|
|
/** Configures the specified endpoint number with the given endpoint type, direction, bank size
|
|
* and banking mode. Once configured, the endpoint may be read from or written to, depending
|
|
* on its direction.
|
|
*
|
|
* \param[in] Number Endpoint number to configure. This must be more than 0 and less than
|
|
* \ref ENDPOINT_TOTAL_ENDPOINTS.
|
|
*
|
|
* \param[in] Type Type of endpoint to configure, a EP_TYPE_* mask. Not all endpoint types
|
|
* are available on Low Speed USB devices - refer to the USB 2.0 specification.
|
|
*
|
|
* \param[in] Direction Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
|
|
* All endpoints (except Control type) are unidirectional - data may only be read
|
|
* from or written to the endpoint bank based on its direction, not both.
|
|
*
|
|
* \param[in] Size Size of the endpoint's bank, where packets are stored before they are transmitted
|
|
* to the USB host, or after they have been received from the USB host (depending on
|
|
* the endpoint's data direction). The bank size must indicate the maximum packet size
|
|
* that the endpoint can handle.
|
|
*
|
|
* \param[in] Banks Number of banks to use for the endpoint being configured, an ENDPOINT_BANK_* mask.
|
|
* More banks uses more USB DPRAM, but offers better performance. Isochronous type
|
|
* endpoints <b>must</b> have at least two banks.
|
|
*
|
|
* \note Endpoints <b>must</b> be configured in ascending order, or bank corruption will occur.
|
|
* \n\n
|
|
*
|
|
* \note Certain models of USB AVR's endpoints may have different maximum packet sizes based on the endpoint's
|
|
* index - refer to the chosen USB AVR's datasheet to determine the maximum bank size for each endpoint.
|
|
* \n\n
|
|
*
|
|
* \note The default control endpoint should not be manually configured by the user application, as
|
|
* it is automatically configured by the library internally.
|
|
* \n\n
|
|
*
|
|
* \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
|
|
* which failed to reconfigure correctly will be selected.
|
|
*
|
|
* \return Boolean true if the configuration succeeded, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
|
|
const uint8_t Type,
|
|
const uint8_t Direction,
|
|
const uint16_t Size,
|
|
const uint8_t Banks) ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
|
|
const uint8_t Type,
|
|
const uint8_t Direction,
|
|
const uint16_t Size,
|
|
const uint8_t Banks)
|
|
{
|
|
return Endpoint_ConfigureEndpoint_Prv(Number, (((Type) << EPTYPE0) | (Direction)),
|
|
((1 << ALLOC) | Banks | Endpoint_BytesToEPSizeMask(Size)));
|
|
}
|
|
|
|
/** Indicates the number of bytes currently stored in the current endpoint's selected bank.
|
|
*
|
|
* \note The return width of this function may differ, depending on the maximum endpoint bank size
|
|
* of the selected AVR model.
|
|
*
|
|
* \ingroup Group_EndpointRW
|
|
*
|
|
* \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
|
|
*/
|
|
static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint16_t Endpoint_BytesInEndpoint(void)
|
|
{
|
|
#if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
|
|
return UEBCX;
|
|
#elif defined(USB_SERIES_4_AVR)
|
|
return (((uint16_t)UEBCHX << 8) | UEBCLX);
|
|
#elif defined(USB_SERIES_2_AVR)
|
|
return UEBCLX;
|
|
#endif
|
|
}
|
|
|
|
/** Get the endpoint address of the currently selected endpoint. This is typically used to save
|
|
* the currently selected endpoint number so that it can be restored after another endpoint has
|
|
* been manipulated.
|
|
*
|
|
* \return Index of the currently selected endpoint.
|
|
*/
|
|
static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint8_t Endpoint_GetCurrentEndpoint(void)
|
|
{
|
|
#if !defined(CONTROL_ONLY_DEVICE)
|
|
return (UENUM & ENDPOINT_EPNUM_MASK);
|
|
#else
|
|
return ENDPOINT_CONTROLEP;
|
|
#endif
|
|
}
|
|
|
|
/** Selects the given endpoint number. If the address from the device descriptors is used, the
|
|
* value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
|
|
* number (and discarding the endpoint direction bit).
|
|
*
|
|
* Any endpoint operations which do not require the endpoint number to be indicated will operate on
|
|
* the currently selected endpoint.
|
|
*
|
|
* \param[in] EndpointNumber Endpoint number to select.
|
|
*/
|
|
static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)
|
|
{
|
|
#if !defined(CONTROL_ONLY_DEVICE)
|
|
UENUM = EndpointNumber;
|
|
#endif
|
|
}
|
|
|
|
/** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
|
|
* In and Out pointers to the bank's contents.
|
|
*
|
|
* \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset.
|
|
*/
|
|
static inline void Endpoint_ResetFIFO(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_ResetFIFO(const uint8_t EndpointNumber)
|
|
{
|
|
UERST = (1 << EndpointNumber);
|
|
UERST = 0;
|
|
}
|
|
|
|
/** Enables the currently selected endpoint so that data can be sent and received through it to
|
|
* and from a host.
|
|
*
|
|
* \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
|
|
*/
|
|
static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_EnableEndpoint(void)
|
|
{
|
|
UECONX |= (1 << EPEN);
|
|
}
|
|
|
|
/** Disables the currently selected endpoint so that data cannot be sent and received through it
|
|
* to and from a host.
|
|
*/
|
|
static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_DisableEndpoint(void)
|
|
{
|
|
UECONX &= ~(1 << EPEN);
|
|
}
|
|
|
|
/** Determines if the currently selected endpoint is enabled, but not necessarily configured.
|
|
*
|
|
* \return Boolean True if the currently selected endpoint is enabled, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsEnabled(void)
|
|
{
|
|
return ((UECONX & (1 << EPEN)) ? true : false);
|
|
}
|
|
|
|
/** Aborts all pending IN transactions on the currently selected endpoint, once the bank
|
|
* has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
|
|
* will terminate all queued transactions, resetting the endpoint banks ready for a new
|
|
* packet.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*/
|
|
static inline void Endpoint_AbortPendingIN(void)
|
|
{
|
|
while (UESTA0X & (0x03 << NBUSYBK0))
|
|
{
|
|
UEINTX |= (1 << RXOUTI);
|
|
while (UEINTX & (1 << RXOUTI));
|
|
}
|
|
}
|
|
|
|
/** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
|
|
* transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
|
|
* \ref Endpoint_ClearOUT() command.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \return Total number of busy banks in the selected endpoint.
|
|
*/
|
|
static inline uint8_t Endpoint_GetBusyBanks(void)
|
|
{
|
|
return (UESTA0X & (0x03 << NBUSYBK0));
|
|
}
|
|
|
|
/** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
|
|
* bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
|
|
* direction). This function will return false if an error has occurred in the endpoint, if the endpoint
|
|
* is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
|
|
* direction and the endpoint bank is full.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction.
|
|
*/
|
|
static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsReadWriteAllowed(void)
|
|
{
|
|
return ((UEINTX & (1 << RWAL)) ? true : false);
|
|
}
|
|
|
|
/** Determines if the currently selected endpoint is configured.
|
|
*
|
|
* \return Boolean true if the currently selected endpoint has been configured, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsConfigured(void)
|
|
{
|
|
return ((UESTA0X & (1 << CFGOK)) ? true : false);
|
|
}
|
|
|
|
/** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
|
|
* interrupt duration has elapsed. Which endpoints have interrupted can be determined by
|
|
* masking the return value against (1 << {Endpoint Number}).
|
|
*
|
|
* \return Mask whose bits indicate which endpoints have interrupted.
|
|
*/
|
|
static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint8_t Endpoint_GetEndpointInterrupts(void)
|
|
{
|
|
return UEINT;
|
|
}
|
|
|
|
/** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
|
|
* endpoints).
|
|
*
|
|
* \param[in] EndpointNumber Index of the endpoint whose interrupt flag should be tested.
|
|
*
|
|
* \return Boolean true if the specified endpoint has interrupted, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
|
|
{
|
|
return ((UEINT & (1 << EndpointNumber)) ? true : false);
|
|
}
|
|
|
|
/** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsINReady(void)
|
|
{
|
|
return ((UEINTX & (1 << TXINI)) ? true : false);
|
|
}
|
|
|
|
/** Determines if the selected OUT endpoint has received new packet from the host.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \return Boolean true if current endpoint is has received an OUT packet, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsOUTReceived(void)
|
|
{
|
|
return ((UEINTX & (1 << RXOUTI)) ? true : false);
|
|
}
|
|
|
|
/** Determines if the current CONTROL type endpoint has received a SETUP packet.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsSETUPReceived(void)
|
|
{
|
|
return ((UEINTX & (1 << RXSTPI)) ? true : false);
|
|
}
|
|
|
|
/** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
|
|
* endpoint for the next packet.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \note This is not applicable for non CONTROL type endpoints.
|
|
*/
|
|
static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_ClearSETUP(void)
|
|
{
|
|
UEINTX &= ~(1 << RXSTPI);
|
|
}
|
|
|
|
/** 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.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*/
|
|
static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_ClearIN(void)
|
|
{
|
|
#if !defined(CONTROL_ONLY_DEVICE)
|
|
UEINTX &= ~((1 << TXINI) | (1 << FIFOCON));
|
|
#else
|
|
UEINTX &= ~(1 << TXINI);
|
|
#endif
|
|
}
|
|
|
|
/** 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.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*/
|
|
static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_ClearOUT(void)
|
|
{
|
|
#if !defined(CONTROL_ONLY_DEVICE)
|
|
UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON));
|
|
#else
|
|
UEINTX &= ~(1 << RXOUTI);
|
|
#endif
|
|
}
|
|
|
|
/** 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 \ref Endpoint_ClearStall() macro
|
|
* is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
|
|
* endpoint.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*/
|
|
static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_StallTransaction(void)
|
|
{
|
|
UECONX |= (1 << STALLRQ);
|
|
}
|
|
|
|
/** Clears the STALL condition on the currently selected endpoint.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*/
|
|
static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_ClearStall(void)
|
|
{
|
|
UECONX |= (1 << STALLRQC);
|
|
}
|
|
|
|
/** Determines if the currently selected endpoint is stalled, false otherwise.
|
|
*
|
|
* \ingroup Group_EndpointPacketManagement
|
|
*
|
|
* \return Boolean true if the currently selected endpoint is stalled, false otherwise.
|
|
*/
|
|
static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline bool Endpoint_IsStalled(void)
|
|
{
|
|
return ((UECONX & (1 << STALLRQ)) ? true : false);
|
|
}
|
|
|
|
/** Resets the data toggle of the currently selected endpoint. */
|
|
static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_ResetDataToggle(void)
|
|
{
|
|
UECONX |= (1 << RSTDT);
|
|
}
|
|
|
|
/** Determines the currently selected endpoint's direction.
|
|
*
|
|
* \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
|
|
*/
|
|
static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint8_t Endpoint_GetEndpointDirection(void)
|
|
{
|
|
return (UECFG0X & ENDPOINT_DIR_IN);
|
|
}
|
|
|
|
/** Sets the direction of the currently selected endpoint.
|
|
*
|
|
* \param[in] DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask.
|
|
*/
|
|
static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask)
|
|
{
|
|
UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | DirectionMask);
|
|
}
|
|
|
|
/** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \return Next byte in the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint8_t Endpoint_Read_Byte(void)
|
|
{
|
|
return UEDATX;
|
|
}
|
|
|
|
/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \param[in] Byte Next byte to write into the the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Write_Byte(const uint8_t Byte)
|
|
{
|
|
UEDATX = Byte;
|
|
}
|
|
|
|
/** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*/
|
|
static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Discard_Byte(void)
|
|
{
|
|
uint8_t Dummy;
|
|
|
|
Dummy = UEDATX;
|
|
}
|
|
|
|
/** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \return Next word in the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint16_t Endpoint_Read_Word_LE(void)
|
|
{
|
|
union
|
|
{
|
|
uint16_t Word;
|
|
uint8_t Bytes[2];
|
|
} Data;
|
|
|
|
Data.Bytes[0] = UEDATX;
|
|
Data.Bytes[1] = UEDATX;
|
|
|
|
return Data.Word;
|
|
}
|
|
|
|
/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \return Next word in the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint16_t Endpoint_Read_Word_BE(void)
|
|
{
|
|
union
|
|
{
|
|
uint16_t Word;
|
|
uint8_t Bytes[2];
|
|
} Data;
|
|
|
|
Data.Bytes[1] = UEDATX;
|
|
Data.Bytes[0] = UEDATX;
|
|
|
|
return Data.Word;
|
|
}
|
|
|
|
/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Write_Word_LE(const uint16_t Word)
|
|
{
|
|
UEDATX = (Word & 0xFF);
|
|
UEDATX = (Word >> 8);
|
|
}
|
|
|
|
/** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Write_Word_BE(const uint16_t Word)
|
|
{
|
|
UEDATX = (Word >> 8);
|
|
UEDATX = (Word & 0xFF);
|
|
}
|
|
|
|
/** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*/
|
|
static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Discard_Word(void)
|
|
{
|
|
uint8_t Dummy;
|
|
|
|
Dummy = UEDATX;
|
|
Dummy = UEDATX;
|
|
}
|
|
|
|
/** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \return Next double word in the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint32_t Endpoint_Read_DWord_LE(void)
|
|
{
|
|
union
|
|
{
|
|
uint32_t DWord;
|
|
uint8_t Bytes[4];
|
|
} Data;
|
|
|
|
Data.Bytes[0] = UEDATX;
|
|
Data.Bytes[1] = UEDATX;
|
|
Data.Bytes[2] = UEDATX;
|
|
Data.Bytes[3] = UEDATX;
|
|
|
|
return Data.DWord;
|
|
}
|
|
|
|
/** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \return Next double word in the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
|
|
static inline uint32_t Endpoint_Read_DWord_BE(void)
|
|
{
|
|
union
|
|
{
|
|
uint32_t DWord;
|
|
uint8_t Bytes[4];
|
|
} Data;
|
|
|
|
Data.Bytes[3] = UEDATX;
|
|
Data.Bytes[2] = UEDATX;
|
|
Data.Bytes[1] = UEDATX;
|
|
Data.Bytes[0] = UEDATX;
|
|
|
|
return Data.DWord;
|
|
}
|
|
|
|
/** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
|
|
{
|
|
UEDATX = (DWord & 0xFF);
|
|
UEDATX = (DWord >> 8);
|
|
UEDATX = (DWord >> 16);
|
|
UEDATX = (DWord >> 24);
|
|
}
|
|
|
|
/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
|
|
* direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*
|
|
* \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer.
|
|
*/
|
|
static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
|
|
{
|
|
UEDATX = (DWord >> 24);
|
|
UEDATX = (DWord >> 16);
|
|
UEDATX = (DWord >> 8);
|
|
UEDATX = (DWord & 0xFF);
|
|
}
|
|
|
|
/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
|
|
*
|
|
* \ingroup Group_EndpointPrimitiveRW
|
|
*/
|
|
static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
|
|
static inline void Endpoint_Discard_DWord(void)
|
|
{
|
|
uint8_t Dummy;
|
|
|
|
Dummy = UEDATX;
|
|
Dummy = UEDATX;
|
|
Dummy = UEDATX;
|
|
Dummy = UEDATX;
|
|
}
|
|
|
|
/* External Variables: */
|
|
/** Global indicating the maximum packet size of the default control endpoint located at address
|
|
* 0 in the device. This value is set to the value indicated in the device descriptor in the user
|
|
* project once the USB interface is initialized into device mode.
|
|
*
|
|
* If space is an issue, it is possible to fix this to a static value by defining the control
|
|
* endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
|
|
* via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
|
|
* read from the descriptors at runtime and instead fixed to the given value. When used, it is
|
|
* important that the descriptor control endpoint size value matches the size given as the
|
|
* FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
|
|
* be used in the descriptors to ensure this.
|
|
*
|
|
* \note This variable should be treated as read-only in the user application, and never manually
|
|
* changed in value.
|
|
*/
|
|
#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
|
|
extern uint8_t USB_ControlEndpointSize;
|
|
#else
|
|
#define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
|
|
#endif
|
|
|
|
/* Function Prototypes: */
|
|
/** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
|
|
* with respect to the data direction. This is a convenience function which can be used to
|
|
* simplify user control request handling.
|
|
*/
|
|
void Endpoint_ClearStatusStage(void);
|
|
|
|
/** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
|
|
* to be read or written to it.
|
|
*
|
|
* \note This routine should not be called on CONTROL type endpoints.
|
|
*
|
|
* \ingroup Group_EndpointRW
|
|
*
|
|
* \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
|
|
*/
|
|
uint8_t Endpoint_WaitUntilReady(void);
|
|
|
|
/* Disable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/** @} */
|
|
|