diff options
Diffstat (limited to 'LUFA/Drivers/USB/LowLevel')
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Device.h | 20 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Endpoint.h | 49 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Host.h | 22 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/OTG.h | 4 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Pipe.h | 51 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/USBController.h | 21 |
6 files changed, 85 insertions, 82 deletions
diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 2f558b197..55f4346a1 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -101,7 +101,7 @@ * \note This macro should only be used if the device has indicated to the host that it * supports the Remote Wakeup feature in the device descriptors, and should only be * issued if the host is currently allowing remote wakeup events from the device (i.e., - * the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile + * the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile * time option is used, this macro is unavailable. * \n\n * @@ -156,7 +156,7 @@ * \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, * at the start of each USB frame when enumerated in device mode. * - * \note Not available when the NO_SOF_EVENTS compile time token is defined. + * \note Not available when the \c NO_SOF_EVENTS compile time token is defined. */ static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_EnableSOFEvents(void) @@ -167,7 +167,7 @@ /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the * \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode. * - * \note Not available when the NO_SOF_EVENTS compile time token is defined. + * \note Not available when the \c NO_SOF_EVENTS compile time token is defined. */ static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_DisableSOFEvents(void) @@ -185,19 +185,19 @@ * lower byte (when more than one descriptor of the given type exists, such as the * case of string descriptors). The type may be one of the standard types defined * in the DescriptorTypes_t enum, or may be a class-specific descriptor type value. - * \param[in] wIndex The language ID of the string to return if the wValue type indicates DTYPE_String, - * otherwise zero for standard descriptors, or as defined in a class-specific - * standards. + * \param[in] wIndex The language ID of the string to return if the \c wValue type indicates + * \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a + * class-specific standards. * \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to * the address of the descriptor. * \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory * space in which the descriptor is stored. This parameter does not exist when one - * of the USE_*_DESCRIPTORS compile time options is used. + * of the \c USE_*_DESCRIPTORS compile time options is used. * - * \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute. + * \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute. * If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to - * allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the - * USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D + * allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the + * \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D * switch. * * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise. diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index 50c0682fe..24c61a69a 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -183,7 +183,7 @@ #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. + * value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined. */ #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8 #endif @@ -194,7 +194,7 @@ #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. + * direction for comparing with the \c ENDPOINT_DESCRIPTOR_DIR_* masks. */ #define ENDPOINT_EPDIR_MASK 0x80 @@ -205,13 +205,13 @@ /** Maximum size in bytes of a given endpoint. * - * \param[in] EPIndex Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1) + * \param[in] EPIndex Endpoint number, a value between 0 and (\ref 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) + * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1) */ #define ENDPOINT_BANKS_SUPPORTED(EPIndex) _ENDPOINT_GET_BANKS(EPIndex) @@ -257,7 +257,7 @@ * \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 + * \param[in] Type Type of endpoint to configure, a \c 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. @@ -269,12 +269,12 @@ * 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. + * \param[in] Banks Number of banks to use for the endpoint being configured, an \c 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 When the ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in ascending - * order, or bank corruption will occur. + * \note When the \c ORDERED_EP_CONFIG compile time option is used, 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 @@ -288,7 +288,7 @@ * \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. + * \return Boolean \c true if the configuration succeeded, \c false otherwise. */ static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number, const uint8_t Type, @@ -360,7 +360,7 @@ } /** 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. + * data In and Out pointers to the bank's contents. * * \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset. */ @@ -393,7 +393,7 @@ /** Determines if the currently selected endpoint is enabled, but not necessarily configured. * - * \return Boolean True if the currently selected endpoint is enabled, false otherwise. + * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise. */ static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Endpoint_IsEnabled(void) @@ -438,7 +438,8 @@ * * \ingroup Group_EndpointPacketManagement * - * \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction. + * \return Boolean \c 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) @@ -448,7 +449,7 @@ /** Determines if the currently selected endpoint is configured. * - * \return Boolean true if the currently selected endpoint has been configured, false otherwise. + * \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise. */ static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Endpoint_IsConfigured(void) @@ -458,7 +459,7 @@ /** 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}). + * masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>. * * \return Mask whose bits indicate which endpoints have interrupted. */ @@ -473,7 +474,7 @@ * * \param[in] EndpointNumber Index of the endpoint whose interrupt flag should be tested. * - * \return Boolean true if the specified endpoint has interrupted, false otherwise. + * \return Boolean \c true if the specified endpoint has interrupted, \c 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) @@ -485,7 +486,7 @@ * * \ingroup Group_EndpointPacketManagement * - * \return Boolean true if the current endpoint is ready for an IN packet, false otherwise. + * \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise. */ static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Endpoint_IsINReady(void) @@ -497,7 +498,7 @@ * * \ingroup Group_EndpointPacketManagement * - * \return Boolean true if current endpoint is has received an OUT packet, false otherwise. + * \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise. */ static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Endpoint_IsOUTReceived(void) @@ -509,7 +510,7 @@ * * \ingroup Group_EndpointPacketManagement * - * \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise. + * \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise. */ static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Endpoint_IsSETUPReceived(void) @@ -591,7 +592,7 @@ * * \ingroup Group_EndpointPacketManagement * - * \return Boolean true if the currently selected endpoint is stalled, false otherwise. + * \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise. */ static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Endpoint_IsStalled(void) @@ -608,7 +609,7 @@ /** Determines the currently selected endpoint's direction. * - * \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask. + * \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask. */ static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline uint8_t Endpoint_GetEndpointDirection(void) @@ -618,7 +619,7 @@ /** Sets the direction of the currently selected endpoint. * - * \param[in] DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask. + * \param[in] DirectionMask New endpoint direction, as a \c ENDPOINT_DIR_* mask. */ static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) ATTR_ALWAYS_INLINE; static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) @@ -848,12 +849,12 @@ * 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 + * endpoint size in the \c 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. + * \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token + * be used in the device descriptors to ensure this. * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index 6f653ff15..48d7926f3 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -96,7 +96,7 @@ * occur. * * The default delay value may be overridden in the user project makefile by definining the - * HOST_DEVICE_SETTLE_DELAY_MS token to tbe required delay in milliseconds, and passed to the + * \c HOST_DEVICE_SETTLE_DELAY_MS token to tbe required delay in milliseconds, and passed to the * compiler using the -D switch. */ #define HOST_DEVICE_SETTLE_DELAY_MS 1000 @@ -258,7 +258,7 @@ * \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, * at the start of each USB frame when a device is enumerated while in host mode. * - * \note Not available when the NO_SOF_EVENTS compile time token is defined. + * \note Not available when the \c NO_SOF_EVENTS compile time token is defined. */ static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_EnableSOFEvents(void) @@ -293,7 +293,7 @@ /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has * completed. * - * \return Boolean true if no bus reset is currently being sent, false otherwise. + * \return Boolean \c true if no bus reset is currently being sent, \c false otherwise. */ static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsBusResetComplete(void) @@ -325,7 +325,7 @@ * false otherwise. While suspended, no USB communications can occur until the bus is resumed, * except for the Remote Wakeup event from the device if supported. * - * \return Boolean true if the bus is currently suspended, false otherwise. + * \return Boolean \c true if the bus is currently suspended, \c false otherwise. */ static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsBusSuspended(void) @@ -336,7 +336,7 @@ /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or * false if the attached device is enumerated in Low Speed mode (1.5Mb/s). * - * \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise. + * \return Boolean \c true if the attached device is enumerated in Full Speed mode, \c false otherwise. */ static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsDeviceFullSpeed(void) @@ -347,7 +347,7 @@ /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting * that the host resume the USB bus and wake up the device, false otherwise. * - * \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise. + * \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise. */ static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsRemoteWakeupSent(void) @@ -375,7 +375,7 @@ /** Determines if a resume from Remote Wakeup request is currently being sent to an attached * device. * - * \return Boolean true if no resume request is currently being sent, false otherwise. + * \return Boolean \c true if no resume request is currently being sent, \c false otherwise. */ static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) @@ -384,7 +384,7 @@ } /* Function Prototypes: */ - /** Convenience function. This routine sends a SetConfiguration standard request to the attached + /** Convenience function. This routine sends a SET CONFIGURATION standard request to the attached * device, with the given configuration index. This can be used to easily set the device * configuration without creating and sending the request manually. * @@ -396,7 +396,7 @@ */ uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber); - /** Convenience function. This routine sends a GetDescriptor standard request to the attached + /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached * device, requesting the device descriptor. This can be used to easily retrieve information * about the device such as its VID, PID and power requirements. * @@ -409,7 +409,7 @@ */ uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr); - /** Convenience function. This routine sends a GetDescriptor standard request to the attached + /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached * device, requesting the string descriptor of the specified index. This can be used to easily * retrieve string descriptors from the device by index, after the index is obtained from the * Device or Configuration descriptors. @@ -427,7 +427,7 @@ void* const Buffer, const uint8_t BufferLength); - /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device. + /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device. * * \note After this routine returns, the control pipe will be selected. * diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h index c5e7bdc5e..5e096ca7a 100644 --- a/LUFA/Drivers/USB/LowLevel/OTG.h +++ b/LUFA/Drivers/USB/LowLevel/OTG.h @@ -97,7 +97,7 @@ /** Determines if the device is currently sending a HNP to an attached host. * - * \return Boolean true if currently sending a HNP to the other connected device, false otherwise + * \return Boolean \c true if currently sending a HNP to the other connected device, \c false otherwise */ static inline bool USB_OTG_Device_IsSendingHNP(void) ATTR_ALWAYS_INLINE; static inline bool USB_OTG_Device_IsSendingHNP(void) @@ -141,7 +141,7 @@ /** Indicates if the connected device is not currently sending a HNP request. * - * \return Boolean true if a HNP is currently being issued by the connected device, false otherwise. + * \return Boolean \c true if a HNP is currently being issued by the connected device, \c false otherwise. */ static inline bool USB_OTG_Host_IsHNPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_OTG_Host_IsHNPReceived(void) diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index bcd926090..75cdf7a7d 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -190,12 +190,12 @@ #define PIPE_EPNUM_MASK 0x0F /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's - * direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks. + * direction for comparing with the \c ENDPOINT_DESCRIPTOR_DIR_* masks. */ #define PIPE_EPDIR_MASK 0x80 /* Enums: */ - /** Enum for the possible error return codes of the Pipe_WaitUntilReady function. + /** Enum for the possible error return codes of the \ref Pipe_WaitUntilReady() function. * * \ingroup Group_PipeRW */ @@ -218,7 +218,7 @@ * * \ingroup Group_PipeRW * - * \return Total number of bytes in the currently selected Pipe's FIFO buffer. + * \return Total number of bytes in the currently selected pipe's FIFO buffer. */ static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline uint16_t Pipe_BytesInPipe(void) @@ -281,7 +281,7 @@ /** Determines if the currently selected pipe is enabled, but not necessarily configured. * - * \return Boolean True if the currently selected pipe is enabled, false otherwise. + * \return Boolean \c true if the currently selected pipe is enabled, \c false otherwise. */ static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsEnabled(void) @@ -291,7 +291,7 @@ /** Gets the current pipe token, indicating the pipe's data direction and type. * - * \return The current pipe token, as a PIPE_TOKEN_* mask. + * \return The current pipe token, as a \c PIPE_TOKEN_* mask. */ static inline uint8_t Pipe_GetPipeToken(void) ATTR_ALWAYS_INLINE; static inline uint8_t Pipe_GetPipeToken(void) @@ -299,12 +299,12 @@ return (UPCFG0X & (0x03 << PTOKEN0)); } - /** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_* + /** Sets the token for the currently selected pipe to one of the tokens specified by the \c PIPE_TOKEN_* * masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during * control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices * which have two endpoints of opposite direction sharing the same endpoint address within the device. * - * \param[in] Token New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask. + * \param[in] Token New pipe token to set the selected pipe to, as a \c PIPE_TOKEN_* mask. */ static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE; static inline void Pipe_SetPipeToken(const uint8_t Token) @@ -333,7 +333,7 @@ /** Determines if the currently selected pipe is configured. * - * \return Boolean true if the selected pipe is configured, false otherwise. + * \return Boolean \c true if the selected pipe is configured, \c false otherwise. */ static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsConfigured(void) @@ -378,7 +378,7 @@ * * \param[in] PipeNumber Index of the pipe whose interrupt flag should be tested. * - * \return Boolean true if the specified pipe has interrupted, false otherwise. + * \return Boolean \c true if the specified pipe has interrupted, \c false otherwise. */ static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) @@ -402,7 +402,7 @@ /** Determines if the currently selected pipe is frozen, and not able to accept data. * - * \return Boolean true if the currently selected pipe is frozen, false otherwise. + * \return Boolean \c true if the currently selected pipe is frozen, \c false otherwise. */ static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsFrozen(void) @@ -422,7 +422,7 @@ * * \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag. * - * \return Boolean true if an error has occurred on the selected pipe, false otherwise. + * \return Boolean \c true if an error has occurred on the selected pipe, \c false otherwise. */ static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsError(void) @@ -440,9 +440,9 @@ } /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This - * value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred. + * value can then be masked against the \c PIPE_ERRORFLAG_* masks to determine what error has occurred. * - * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe. + * \return Mask comprising of \c PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe. */ static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline uint8_t Pipe_GetErrorFlags(void) @@ -476,7 +476,8 @@ * * \ingroup Group_PipePacketManagement * - * \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction. + * \return Boolean \c true if the currently selected pipe may be read from or written to, depending + * on its direction. */ static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsReadWriteAllowed(void) @@ -488,7 +489,7 @@ * * \ingroup Group_PipePacketManagement * - * \return Boolean true if the current pipe has received an IN packet, false otherwise. + * \return Boolean \c true if the current pipe has received an IN packet, \c false otherwise. */ static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsINReceived(void) @@ -500,7 +501,7 @@ * * \ingroup Group_PipePacketManagement * - * \return Boolean true if the current pipe is ready for an OUT packet, false otherwise. + * \return Boolean \c true if the current pipe is ready for an OUT packet, \c false otherwise. */ static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsOUTReady(void) @@ -513,7 +514,7 @@ * * \ingroup Group_PipePacketManagement * - * \return Boolean true if the current pipe is ready for a SETUP packet, false otherwise. + * \return Boolean \c true if the current pipe is ready for a SETUP packet, \c false otherwise. */ static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsSETUPSent(void) @@ -561,7 +562,7 @@ * * \ingroup Group_PipePacketManagement * - * \return Boolean true if an NAK has been received on the current pipe, false otherwise. + * \return Boolean \c true if an NAK has been received on the current pipe, \c false otherwise. */ static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsNAKReceived(void) @@ -585,7 +586,7 @@ * * \ingroup Group_PipePacketManagement * - * \return Boolean true if the current pipe has been stalled by the attached device, false otherwise. + * \return Boolean \c true if the current pipe has been stalled by the attached device, \c false otherwise. */ static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Pipe_IsStalled(void) @@ -843,7 +844,7 @@ * * \param[in] Number Pipe number to configure. This must be more than 0 and less than \ref PIPE_TOTAL_PIPES. * - * \param[in] Type Type of pipe to configure, a EP_TYPE_* mask. Not all pipe types are available on Low + * \param[in] Type Type of pipe to configure, an \c EP_TYPE_* mask. Not all pipe types are available on Low * Speed USB devices - refer to the USB 2.0 specification. * * \param[in] Token Pipe data token, either \ref PIPE_TOKEN_SETUP, \ref PIPE_TOKEN_OUT or \ref PIPE_TOKEN_IN. @@ -857,11 +858,11 @@ * the pipe's data direction). The bank size must indicate the maximum packet size that * the pipe can handle. * - * \param[in] Banks Number of banks to use for the pipe being configured, a PIPE_BANK_* mask. More banks + * \param[in] Banks Number of banks to use for the pipe being configured, a \c PIPE_BANK_* mask. More banks * uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b> * have at least two banks. * - * \note When the ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order, + * \note When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order, * or bank corruption will occur. * \n\n * @@ -876,7 +877,7 @@ * \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which * failed to reconfigure correctly will be selected. * - * \return Boolean true if the configuration succeeded, false otherwise. + * \return Boolean \c true if the configuration succeeded, \c false otherwise. */ bool Pipe_ConfigurePipe(const uint8_t Number, const uint8_t Type, @@ -899,8 +900,8 @@ * * \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check. * - * \return Boolean true if a pipe bound to the given endpoint address of the specified direction is found, false - * otherwise. + * \return Boolean \c true if a pipe bound to the given endpoint address of the specified direction is found, + * \c false otherwise. */ bool Pipe_IsEndpointBound(const uint8_t EndpointAddress); diff --git a/LUFA/Drivers/USB/LowLevel/USBController.h b/LUFA/Drivers/USB/LowLevel/USBController.h index 29c9b07be..ea3d8fa99 100644 --- a/LUFA/Drivers/USB/LowLevel/USBController.h +++ b/LUFA/Drivers/USB/LowLevel/USBController.h @@ -192,10 +192,11 @@ /* Inline Functions: */ #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__) - /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power), - * otherwise returns false. + /** Determines if the VBUS line is currently high (i.e. the USB host is supplying power). * * \note This function is not available on some AVR models which do not support hardware VBUS monitoring. + * + * \return Boolean \c true if the VBUS line is currently detecting power from a host, \c false otherwise. */ static inline bool USB_VBUS_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_VBUS_GetStatus(void) @@ -248,20 +249,20 @@ * * \param[in] Options Mask indicating the options which should be used when initializing the USB * interface to control the USB interface's behaviour. This should be comprised of - * a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the - * PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device + * a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the + * PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device * mode speed. * * \note To reduce the FLASH requirements of the library if only device or host mode is required, - * the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY - * (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler + * the mode can be statically set in the project makefile by defining the token \c USB_DEVICE_ONLY + * (for device mode) or \c USB_HOST_ONLY (for host mode), passing the token to the compiler * via the -D switch. If the mode is statically set, this parameter does not exist in the * function prototype. * \n\n * * \note To reduce the FLASH requirements of the library if only fixed settings are are required, * the options may be set statically in the same manner as the mode (see the Mode parameter of - * this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token, + * this function). To statically set the USB options, pass in the \c USE_STATIC_OPTIONS token, * defined to the appropriate options masks. When the options are statically set, this * parameter does not exist in the function prototype. * \n\n @@ -269,7 +270,7 @@ * \note The mode parameter does not exist on devices where only one mode is possible, such as USB * AVR models which only implement the USB device mode in hardware. * - * \see Device.h for the USB_DEVICE_OPT_* masks. + * \see \ref Group_Device for the \c USB_DEVICE_OPT_* masks. */ void USB_Init( #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__) @@ -309,7 +310,7 @@ * * \note When the controller is initialized into UID autodetection mode, this variable will hold the * currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller - * is fixed into a specific mode (either through the USB_DEVICE_ONLY or USB_HOST_ONLY compile time + * is fixed into a specific mode (either through the \c USB_DEVICE_ONLY or \c USB_HOST_ONLY compile time * options, or a limitation of the USB controller in the chosen device model) this will evaluate to * a constant of the appropriate value and will never evaluate to \ref USB_MODE_None even when the * USB interface is not initialized. @@ -323,7 +324,7 @@ #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__) /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init() - * was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module. + * was called. This value will be one of the \c USB_MODE_* masks defined elsewhere in this module. * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. |