From 0bf24677497dee28f092f882e1db396d907a3fc1 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 4 Jan 2018 20:10:18 +1100 Subject: Minor documentation improvements. --- LUFA/Drivers/USB/Core/StdDescriptors.h | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'LUFA/Drivers/USB/Core/StdDescriptors.h') diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index 381c02c53..8b834c664 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -121,14 +121,17 @@ /** \name USB Configuration Descriptor Attribute Masks */ //@{ - /** Mask for the reserved bit in the Configuration Descriptor's \c ConfigAttributes field, which must be set on all - * devices for historical purposes. + /** Mask for the reserved bit in the Configuration Descriptor's \c ConfigAttributes field, which must be always + * set on all USB devices for historical purposes. */ #define USB_CONFIG_ATTR_RESERVED 0x80 /** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t * descriptor's \c ConfigAttributes value to indicate that the specified configuration can draw its power - * from the device's own power source. + * from the device's own power source, instead of drawing it from the USB host. + * + * Note that the host will probe this dynamically - the device should report its current power state via the + * \ref USB_Device_CurrentlySelfPowered global variable. */ #define USB_CONFIG_ATTR_SELFPOWERED 0x40 @@ -136,6 +139,10 @@ * descriptor's \c ConfigAttributes value to indicate that the specified configuration supports the * remote wakeup feature of the USB standard, allowing a suspended USB device to wake up the host upon * request. + * + * If set, the host will dynamically enable and disable remote wakeup support, indicated via the + * \ref USB_Device_RemoteWakeupEnabled global variable. To initiate a remote wakeup of the host (when allowed) + * see \ref USB_Device_RemoteWakeupEnabled(). */ #define USB_CONFIG_ATTR_REMOTEWAKEUP 0x20 //@} -- cgit v1.2.3 From ad9225bdd34230e13333be5d4c29e4f96abc9b2b Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 4 Jan 2018 20:12:48 +1100 Subject: Update copyrights for 2018. --- LUFA/Drivers/USB/Core/StdDescriptors.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'LUFA/Drivers/USB/Core/StdDescriptors.h') diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index 8b834c664..20cc44f72 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2017. + Copyright (C) Dean Camera, 2018. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2018 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 -- cgit v1.2.3 From 086975bd9442e86693fce2d16f003c4ad170cdac Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 22 Apr 2018 15:59:23 +1000 Subject: Fix USB_STRING_DESCRIPTOR_ARRAY() not accepting more than two byte long arrays. --- LUFA/Drivers/USB/Core/StdDescriptors.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'LUFA/Drivers/USB/Core/StdDescriptors.h') diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index 20cc44f72..d8e8d3a3e 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -97,7 +97,7 @@ * * \param[in] ... Characters to initialize a USB String Descriptor structure with. */ - #define USB_STRING_DESCRIPTOR_ARRAY(...) { .Header = {.Size = sizeof(USB_Descriptor_Header_t) + sizeof((uint16_t){__VA_ARGS__}), .Type = DTYPE_String}, .UnicodeString = {__VA_ARGS__} } + #define USB_STRING_DESCRIPTOR_ARRAY(...) { .Header = {.Size = sizeof(USB_Descriptor_Header_t) + sizeof((uint16_t[]){__VA_ARGS__}), .Type = DTYPE_String}, .UnicodeString = {__VA_ARGS__} } /** Macro to encode a given major/minor/revision version number into Binary Coded Decimal format for descriptor * fields requiring BCD encoding, such as the USB version number in the standard device descriptor. -- cgit v1.2.3 From 16f4492eb4783f3821155d87907ad0db7be9cc90 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 17 Jun 2018 13:55:06 +1000 Subject: Move class-specific functional descriptor definitions to their respective classes. --- LUFA/Drivers/USB/Core/StdDescriptors.h | 2 -- 1 file changed, 2 deletions(-) (limited to 'LUFA/Drivers/USB/Core/StdDescriptors.h') diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index d8e8d3a3e..0b677637b 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -215,8 +215,6 @@ DTYPE_Other = 0x07, /**< Indicates that the descriptor is of other type. */ DTYPE_InterfacePower = 0x08, /**< Indicates that the descriptor is an interface power descriptor. */ DTYPE_InterfaceAssociation = 0x0B, /**< Indicates that the descriptor is an interface association descriptor. */ - DTYPE_CSInterface = 0x24, /**< Indicates that the descriptor is a class specific interface descriptor. */ - DTYPE_CSEndpoint = 0x25, /**< Indicates that the descriptor is a class specific endpoint descriptor. */ }; /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors. */ -- cgit v1.2.3 From 101ed6b74e0d6549e53a7c8216147af37ffc70df Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 8 Jan 2019 19:59:41 +1100 Subject: Documentation: Update copyrights to 2019. --- LUFA/Drivers/USB/Core/StdDescriptors.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'LUFA/Drivers/USB/Core/StdDescriptors.h') diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index 0b677637b..70e97940c 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2018. + Copyright (C) Dean Camera, 2019. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2018 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2019 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 -- cgit v1.2.3