Place generic USB header and source files into the documentation tree.

This commit is contained in:
Ken Sarkies
2013-03-11 09:36:57 +10:30
parent 2288e35739
commit 1374d2622b
15 changed files with 571 additions and 0 deletions

View File

@@ -1,3 +1,18 @@
/** @defgroup usb_cdc_defines USB CDC Type Definitions
@brief <b>Defined Constants and Types for the USB CDC Type Definitions</b>
@ingroup USB_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Gareth McMullin <gareth@blacksphere.co.nz>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -17,6 +32,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef __CDC_H
#define __CDC_H
@@ -125,3 +142,6 @@ struct usb_cdc_notification {
} __attribute__((packed));
#endif
/**@}*/

View File

@@ -1,3 +1,18 @@
/** @defgroup usb_dfu_defines USB DFU Type Definitions
@brief <b>Defined Constants and Types for the USB DFU Type Definitions</b>
@ingroup USB_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Gareth McMullin <gareth@blacksphere.co.nz>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -17,6 +32,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef __DFU_H
#define __DFU_H
@@ -79,3 +96,6 @@ struct usb_dfu_descriptor {
} __attribute__((packed));
#endif
/**@}*/

View File

@@ -0,0 +1,32 @@
/** @mainpage libopencm3 Generic USB
@version 1.0.0
@date 10 March 2013
API documentation for Generic USB.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup USB Generic USB
Libraries for Generic USB.
@version 1.0.0
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/** @defgroup USB_defines Generic USB Defines
@brief Defined Constants and Types for Generic USB.
@version 1.0.0
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/

View File

@@ -1,3 +1,18 @@
/** @defgroup usb_hid_defines USB HID Type Definitions
@brief <b>Defined Constants and Types for the USB HID Type Definitions</b>
@ingroup USB_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Gareth McMullin <gareth@blacksphere.co.nz>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -17,6 +32,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef __HID_H
#define __HID_H
@@ -36,3 +53,6 @@ struct usb_hid_descriptor {
} __attribute__((packed));
#endif
/**@}*/

View File

@@ -1,3 +1,18 @@
/** @defgroup usb_driver_defines USB Drivers
@brief <b>Defined Constants and Types for the USB Drivers</b>
@ingroup USB_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Gareth McMullin <gareth@blacksphere.co.nz>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -17,6 +32,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef __USBD_H
#define __USBD_H
@@ -100,3 +117,6 @@ extern void usbd_cable_connect(usbd_device *usbd_dev, u8 on);
END_DECLS
#endif
/**@}*/

View File

@@ -1,3 +1,22 @@
/** @defgroup usb_type_defines USB Standard Structure Definitions
@brief <b>Defined Constants and Types for the USB Standard Structure Definitions</b>
@ingroup USB_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Gareth McMullin <gareth@blacksphere.co.nz>
@date 10 March 2013
A set of structure definitions for the USB control structures
defined in chapter 9 of the "Univeral Serial Bus Specification Revision 2.0"
Available from the USB Implementers Forum - http://www.usb.org/
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -17,6 +36,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef __USBSTD_H
#define __USBSTD_H
@@ -227,3 +248,6 @@ enum usb_language_id {
USB_LANGID_ENGLISH_US = 0x409,
};
#endif
/**@}*/