EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

usb: Improved comments of USB API

Browse Source 
usbd.h: more comments for bmRequestType and bmAttributes bitfield macros
usbd.h: migrated and added API doxyblocks from implementations (*.c)
This commit is contained in:
fenugrec
2015-10-13 14:22:33 -04:00
committed by Karl Palsson
parent 7814d06095
commit c899273c62
3 changed files with 81 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
lib/usb/usb.c
View File

@@ -39,28 +39,6 @@ LGPL License Terms @ref lgpl_license
#include <libopencm3/usb/usbd.h>
#include "usb_private.h"
/**
* Main initialization entry point.
*
* Initialize the USB firmware library to implement the USB device described
* by the descriptors provided.
*
* It is required that the 48MHz USB clock is already available.
*
* @param driver TODO
* @param dev Pointer to USB device descriptor. This must not be changed while
* the device is in use.
* @param conf Pointer to array of USB configuration descriptors. These must
* not be changed while the device is in use. The length of this
* array is determined by the bNumConfigurations field in the
* device descriptor.
* @param strings TODO
* @param control_buffer Pointer to array that would hold the data
* received during control requests with DATA
* stage
* @param control_buffer_size Size of control_buffer
* @return the usb device initialized for use. (currently cannot fail).
*/
usbd_device *usbd_init(const usbd_driver *driver,
const struct usb_device_descriptor *dev,
const struct usb_config_descriptor *conf,