diff options
Diffstat (limited to 'atmel-samd/asf4/samd51/documentation')
8 files changed, 242 insertions, 0 deletions
diff --git a/atmel-samd/asf4/samd51/documentation/usb_device_composite.rst b/atmel-samd/asf4/samd51/documentation/usb_device_composite.rst new file mode 100644 index 000000000..1d6151cc2 --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_device_composite.rst @@ -0,0 +1,32 @@ +==================== +USB Device Composite +==================== + +USB Device Composite is a part of the USB Device Stack library. It provides the support for +combining different USB classes into one USB device application. For more detailed features +or use cases introduction, user can refer to the related class documents. + + +Features +-------- +* Combination of different USB classes. + + +Applications +------------ + +* An USB device which is composed by CDC ACM, HID Keyboard,etc. + +Dependencies +------------ + +* USB Device Driver +* USB Device Stack Core +* USB Device CDC +* USB Device HID + + +Limitations +----------- + +N/A diff --git a/atmel-samd/asf4/samd51/documentation/usb_device_core.rst b/atmel-samd/asf4/samd51/documentation/usb_device_core.rst new file mode 100644 index 000000000..fc7018625 --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_device_core.rst @@ -0,0 +1,41 @@ +=============== +USB Device Core +=============== + +USB Device Core is a part of the USB Device Stack library. It handles all the requests +during USB Enumeration process and helps upper class driver to be installed successfully +if only the descriptor configuration is correct. For more detailed description about Bus +Enumeration, user can refer to Chapter 9 (USB Device Framework) in Universal Serial Bus +Specification. + +Features +-------- +* Initialization/de-initialization +* Enabling/disabling USB device class components +* Data Transfer +* Attaching/detaching control +* Waking up by USB host +* Callbacks management on: + + * SOF event + * USB Device state change + * USB Device request handler + + +Applications +------------ + +N/A + +Dependencies +------------ + +* USB Device Driver +* USB Protocol Core + + +Limitations +----------- + +* It is recommended that at least one device class should run above the USB + device core. diff --git a/atmel-samd/asf4/samd51/documentation/usb_protocol_cdc.rst b/atmel-samd/asf4/samd51/documentation/usb_protocol_cdc.rst new file mode 100644 index 000000000..3cf414b92 --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_protocol_cdc.rst @@ -0,0 +1,24 @@ +================ +USB CDC Protocol +================ + +USB CDC Protocol is a part of the USB Device Stack library. It provides basic +macro definitions and data structures which are compliant with CDC(Communications +Device Class) Specification version 1.2. + + +Applications +------------ + +N/A + +Dependencies +------------ + +N/A + + +Limitations +----------- + +N/A diff --git a/atmel-samd/asf4/samd51/documentation/usb_protocol_core.rst b/atmel-samd/asf4/samd51/documentation/usb_protocol_core.rst new file mode 100644 index 000000000..4d5e01bbf --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_protocol_core.rst @@ -0,0 +1,40 @@ +================= +USB Protocol Core +================= + +USB Protocol Core is a part of the USB Device Stack library. It provides basic +macro definitions, data structures and API functions which are compliant with +USB specification version 2.0.0/2.0.1 for user. + +In addition, it provides interfaces of USB descriptor searching for the upper +layer to use, which is especially helpful in the USB enumeration process. + +Features +-------- +* Packaging USB device, configuration, interface, endpoint descriptors. +* Getting the descriptor length or type from an assigned USB descriptor. +* Getting VID, PID value from an assigned USB descriptor. +* Getting the total length of an USB configuration descriptor. +* Finding the next valid descriptor in a given USB descriptor. +* Finding an endpoint descriptor in a given USB descriptor. +* Finding a specific descriptor by an assigned descriptor type. +* Finding a configure descriptor by an assigned configure value. +* Finding a string descriptor by an assigned string index. + + +Applications +------------ + +N/A + +Dependencies +------------ + +N/A + + +Limitations +----------- + +N/A + diff --git a/atmel-samd/asf4/samd51/documentation/usb_protocol_hid.rst b/atmel-samd/asf4/samd51/documentation/usb_protocol_hid.rst new file mode 100644 index 000000000..613c22cec --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_protocol_hid.rst @@ -0,0 +1,24 @@ +================ +USB HID Protocol +================ + +USB HID Protocol is a part of the USB Device Stack library. It provides basic +macro definitions and data structures which are compliant with HID(Human Interface +Device) Specification version 1.11. + + +Applications +------------ + +N/A + +Dependencies +------------ + +N/A + + +Limitations +----------- + +N/A diff --git a/atmel-samd/asf4/samd51/documentation/usb_protocol_hub.rst b/atmel-samd/asf4/samd51/documentation/usb_protocol_hub.rst new file mode 100644 index 000000000..d60b0bbfd --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_protocol_hub.rst @@ -0,0 +1,32 @@ +====================== +USB Protocol Hub Class +====================== + +USB Protocol Hub Class is a part of the USB Device Stack library. It provides +basic macro definitions, data structures and API functions which are compliant +with Hub part of USB specification version 2.0.0/2.0.1 for user. + +In addition, it provides interfaces of USB requests filling and input data +analyzing for the upper layer to use. + +Features +-------- +* Hub requests filling +* Hub change bitmap analyzing + +Applications +------------ + +N/A + +Dependencies +------------ + +N/A + + +Limitations +----------- + +N/A + diff --git a/atmel-samd/asf4/samd51/documentation/usb_protocol_msc.rst b/atmel-samd/asf4/samd51/documentation/usb_protocol_msc.rst new file mode 100644 index 000000000..6c7df5450 --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_protocol_msc.rst @@ -0,0 +1,25 @@ +================ +USB MSC Protocol +================ + +USB MSC Protocol is a part of the USB Device Stack library. It provides basic +macro definitions and data structures which are compliant with Mass Storage +Control/Bulk/Interrupt (CBI) Specification 1.1 and Mass Storage UFI Command +Specification 1.0. + + +Applications +------------ + +N/A + +Dependencies +------------ + +N/A + + +Limitations +----------- + +N/A diff --git a/atmel-samd/asf4/samd51/documentation/usb_protocol_vendor.rst b/atmel-samd/asf4/samd51/documentation/usb_protocol_vendor.rst new file mode 100644 index 000000000..e244675a6 --- /dev/null +++ b/atmel-samd/asf4/samd51/documentation/usb_protocol_vendor.rst @@ -0,0 +1,24 @@ +=================== +USB Vendor Protocol +=================== + +USB Vendor Protocol is a part of the USB Device Stack library. It provides basic +macro definitions which are compliant with Universal Serial Bus Specification +Revision 2.0. + + +Applications +------------ + +N/A + +Dependencies +------------ + +N/A + + +Limitations +----------- + +N/A |