[tuxdroid-svn] r1176 - firmware/fuxusb/trunk/src
Status: Beta
Brought to you by:
ks156
Menu
▾
▴
[tuxdroid-svn] r1176 - firmware/fuxusb/trunk/src
|
From: Paul_R <c2m...@c2...> - 2008-05-20 09:29:05
|
Author: Paul_R Date: 2008-05-20 11:28:43 +0200 (Tue, 20 May 2008) New Revision: 1176 Modified: firmware/fuxusb/trunk/src/config.h firmware/fuxusb/trunk/src/global.h firmware/fuxusb/trunk/src/usb_commands.c firmware/fuxusb/trunk/src/usb_commands.h firmware/fuxusb/trunk/src/usb_desc.c firmware/fuxusb/trunk/src/usb_desc.h firmware/fuxusb/trunk/src/usb_enum.c firmware/fuxusb/trunk/src/usb_enum.h firmware/fuxusb/trunk/src/usb_ep.c firmware/fuxusb/trunk/src/usb_ep.h firmware/fuxusb/trunk/src/usb_misc.c firmware/fuxusb/trunk/src/usb_misc.h Log: * Finished to comment the USB modules. Modified: firmware/fuxusb/trunk/src/config.h =================================================================== --- firmware/fuxusb/trunk/src/config.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/config.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -30,7 +30,7 @@ #include <stdio.h> /* Enable the HID interface */ -//#define HID_DEVICE +#define HID_DEVICE /* Debug modes : Don't forget to define MAIN_DEBUG to be able to use printf */ //#define MAIN_DEBUG Modified: firmware/fuxusb/trunk/src/global.h =================================================================== --- firmware/fuxusb/trunk/src/global.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/global.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -22,10 +22,16 @@ #ifndef _GLOBAL_H_ #define _GLOBAL_H_ +/** \mainpage Fuxusb firmware documentation of the Tux Droid open source robot + * + * \section SVN SVN repository + * http://svn.tuxisalive.com/firmware/fuxusb/trunk + */ + /** \defgroup fuxusb USB Dongle for TuxDroid. */ - /** \defgroup main Main function. + /** \defgroup main Main function * \brief Fuxusb main function * \ingroup fuxusb */ @@ -39,20 +45,36 @@ /** * \defgroup usb_enum USB enumeration process - \brief This module analyse the enumeration requests and send back required + \brief This module analyze the enumeration requests and send back required informations. \ingroup fuxusb */ -/** \mainpage Fuxusb firmware documentation of the Tux Droid open source robot - * - * \section SVN SVN repository - * http://svn.tuxisalive.com/firmware/fuxusb/trunk +/** + * \defgroup usb_desc USB descriptor + \brief This module contain the descriptors structures. + + \ingroup fuxusb */ +/** \defgroup usb_ep USB Endpoints + * \brief Endpoints control. + * \ingroup fuxusb + */ + + +/** \defgroup usb_cmd USB commands + * \brief Functions to prepare status and parse received commands. + * \ingroup fuxusb + */ + +/** \defgroup usb_misc USB misc functions + * \ingroup fuxusb + */ + /** - * \defgroup fifo_spk Speaker FIFO. + * \defgroup fifo_spk Speaker FIFO \brief FIFO_SPK is used for the speaker data, received from the USB and sent to the RF. @@ -64,11 +86,10 @@ */ /** - * \defgroup fifo_mic Microphone FIFO. + * \defgroup fifo_mic Microphone FIFO \brief FIFO_MIC used for the microphone data, received from the RF and sent to the computer. - - This FIFO are specific for this application and the context. + This FIFO is specific for this application and the context. It's optimized for speed. It's not circular, and the access to the buffer are direct. @@ -76,7 +97,7 @@ */ /** - * \defgroup fifo_stt Status FIFO. + * \defgroup fifo_stt Status FIFO \brief FIFO_STT is used for the status data, received from the RF and sent to the computer. Modified: firmware/fuxusb/trunk/src/usb_commands.c =================================================================== --- firmware/fuxusb/trunk/src/usb_commands.c 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_commands.c 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,6 +19,11 @@ /* $Id$ */ +/** \file usb_commands.c + \brief USB commands functions. + \ingroup usb_cmd +*/ + #include "config.h" #include "global.h" #include "usb_ep.h" @@ -38,7 +43,10 @@ static void reset_dongle(void); /** - * \brief Parse the received command + * \brief Parse the received command. + * This function analyse the commands, and determine if it's a Tux, dongle or + * bootloader command. + * \ingroup usb_cmd */ void commands_parser(void) { @@ -84,6 +92,7 @@ /** *\brief Fill the USB EP Fifo with statuses. * This function prepare the USB EP Fifo with the lasts statuses received. + * \ingroup usb_cmd */ void prepare_status(void) { @@ -123,10 +132,11 @@ } } -/* - * Acknowledge or not a bootloader command. +/** + * \brief Acknowledge or not a bootloader command. * \param ack Send an ACK if ack is set, NACK otherwise * \param p1, p2, p3: optional paramaters + * \ingroup usb_cmd */ void bl_acknowledge(uint8_t ack, uint8_t p1, uint8_t p2, uint8_t p3) { @@ -147,8 +157,9 @@ send_status(); } -/* +/** * \brief Parse commands for dongle. + * This function parse the commands for dongle. */ static void dongle_cmd_parser(void) { @@ -215,6 +226,8 @@ /** *\brief Perform a complete reset. + * This function reset the dongle. To do this, the watchdog timer is configured + * and started, and an infinite loop wait the reset. */ static void reset_dongle(void) { Modified: firmware/fuxusb/trunk/src/usb_commands.h =================================================================== --- firmware/fuxusb/trunk/src/usb_commands.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_commands.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,29 +19,58 @@ /* $Id$ */ +/** \file usb_commands.h + \brief USB commands header. + \ingroup usb_cmd +*/ + #ifndef _USB_COMMANDS_H_ #define _USB_COMMANDS_H_ +/** \name Commands type + * @{ */ +/** Commands for Tux */ #define TUX_CMD_HDR 0 +/** Commands for the dongle */ #define DONGLE_CMD_HDR 1 +/** Commands for the bootloader */ #define BOOTLOADER_CMD_HDR 2 +/* @} */ +/** \name Commands sub-type + * @{ */ +/** \name Commands sub-types for the dongle + * @{ */ +/** Maintenance */ #define DONGLE_CMD 1 +/** Audio */ #define TTS_CMD 2 +/* @} */ +/* @} */ +/** \name Maintenance commands sub-type + * @{ */ +/** New status request */ #define STATUS_REQUEST 0x00 +/** RF reset request */ #define RF_RESET 0xFD +/** Dongle reset request */ #define USB_RESET 0xFE +/** Jump ISP mode request */ #define ISP_MODE 0xFF +/* @} */ - +/** \name Audio commands sub-type + * @{ */ +/** Switch to normal audio pipe */ #define TTS_OFF 0 +/** Switch to TTS audio pipe */ #define TTS_ON 1 +/* @} */ /* Functions */ void bl_acknowledge(uint8_t ack, uint8_t p1, uint8_t p2, uint8_t p3); void commands_parser(void); void prepare_status(void); -void bl_send_ack(void); #endif // _USB_COMMANDS_H_ Modified: firmware/fuxusb/trunk/src/usb_desc.c =================================================================== --- firmware/fuxusb/trunk/src/usb_desc.c 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_desc.c 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,10 +19,17 @@ /* $Id$ */ +/** \file usb_desc.c + \brief Structures and variable for the descriptors + \ingroup usb_desc +*/ + #include "config.h" #include "usb_desc.h" - +/** \brief Device descriptor. + * This descriptor inform host about the device. + */ code struct usb_st_device_descriptor usb_device_descriptor = { sizeof(usb_device_descriptor), DEVICE, USB_SPECIFICATION, DEVICE_CLASS, @@ -31,34 +38,79 @@ SN_STRING_INDEX, NB_CONFIGURATION }; +/** \brief Manufactrer string. + * Contain the manufacturer string + * string : KYSOH + * size : 5 + */ code struct usb_st_manufacturer usb_manufacturer = { sizeof(usb_manufacturer), STRING, USB_MANUFACTURER_NAME }; +/** \brief Product string. + * Contain the product string + * string : TuxDroid + * size : 8 + */ code struct usb_st_product usb_product = { sizeof(usb_product), STRING, USB_PRODUCT_NAME }; + +/** \brief Serial number. + * string : 10001 + * size : 5 + */ code struct usb_st_serial_number usb_serial_number = { sizeof(usb_serial_number), STRING, USB_SERIAL_NUMBER }; + +/** \brief Language code. + * Define the language + * string : 0x0904 + */ code struct usb_st_language_descriptor usb_language = { sizeof(usb_language), STRING, LANGUAGE_ID }; + +/** \brief Configuration string. + * Contain the configuration name + * string : TuxDroid + * size : 8 + */ code struct usb_st_config usb_config = { sizeof(usb_config), STRING, USB_CONFIG_NAME }; +/** \brief Microphone interface. + * Contain microphone interface string + * string : TuxDroid - Micro + */ code struct usb_st_micro_descriptor usb_audio_micro = { sizeof(usb_audio_micro), STRING, AUDIO_MICRO_NAME }; +/** \brief Speaker interface. + * Contain speaker interface string + * string : TuxDroid - Speaker + */ code struct usb_st_speaker_descriptor usb_audio_speaker = { sizeof(usb_audio_speaker), STRING, AUDIO_SPEAKER_NAME }; +/** \brief TTS interface. + * Contain tts interface string + * string : TuxDroid - TTS + */ code struct usb_st_tts_descriptor usb_audio_tts = { sizeof(usb_audio_tts), STRING, AUDIO_TTS_NAME }; +/** \brief Audio interface 1. + * Contain the first audio interface name (micro and speaker) + * string : TuxDroid - Audio + */ code struct usb_st_audio_descriptor usb_audio_normal = { sizeof(usb_audio_normal), STRING, AUDIO_NORMAL_NAME }; +/** \brief General structure. + * This structure contain all the descriptors. + */ code struct usb_configuration_s usb_configuration = { { 9, CONFIGURATION, CONF_LENGTH, NB_INTERFACE, CONF_NB, @@ -584,3 +636,5 @@ } #endif }; + +/* @} */ Modified: firmware/fuxusb/trunk/src/usb_desc.h =================================================================== --- firmware/fuxusb/trunk/src/usb_desc.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_desc.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,72 +19,88 @@ /* $Id$ */ +/** \file usb_desc.h + \brief Structures and variable for the descriptors + \ingroup usb_desc +*/ + #ifndef _USB_DESC_H_ #define _USB_DESC_H_ #include "config.h" #include "version.h" - -/* USB descriptor type */ +/** \name Descriptors type + * @{ */ +/** \name Standard descriptors + * @{ */ +/** Device descriptor request */ #define DEVICE 0x01 +/** Device descriptor request */ #define CONFIGURATION 0x02 +/** Device descriptor request */ #define STRING 0x03 +/** Device descriptor request */ #define INTERFACE 0x04 +/** Device descriptor request */ #define ENDPOINT 0x05 +/*! @} */ +/** \name HID specific descriptors + * @{ */ +/** HID descriptor request */ +#define HID 0x21 +/** Report descriptor request */ +#define REPORT 0x22 +/*! @} */ +/*! @} */ -/* HID specifics descriptors */ - -/* Standard features*/ -#define DEVICE_REMOTE_WAKEUP_FEATURE 0x01 -#define ENDPOINT_HALT_FEATURE 0x00 - -/* Device status */ +/** \name Device status, states and configs + * @{ */ +/** Supply status */ #define SELF_POWERED 1 - -/* Device state */ +/** Attached state */ #define ATTACHED 0 +/** Powered state */ #define POWERED 1 +/** Default state */ #define DEFAULT 2 +/** Addressed state */ #define ADDRESSED 3 +/** Configured state */ #define CONFIGURED 4 +/** Suspended state */ #define SUSPENDED 5 - +/** Bus powered config */ #define USB_CONFIG_BUSPOWERED 0x80 +/** Self powered config */ #define USB_CONFIG_SELFPOWERED 0x40 +/** Remote wakeup config */ #define USB_CONFIG_REMOTEWAKEUP 0x20 +/*! @} */ -/* Endpoints */ +/** \name Endpoints + * @{ */ +/** \name IN Endpoints + * @{ */ #define OUT_ENDPOINT1 0x01 #define OUT_ENDPOINT2 0x02 #define OUT_ENDPOINT3 0x03 #define OUT_ENDPOINT4 0x04 #define OUT_ENDPOINT5 0x05 -#define OUT_ENDPOINT6 0x06 - +#define OUT_ENDPOINT6 0x06 +/*! @} */ +/** \name OUT Endpoints + * @{ */ #define IN_ENDPOINT1 0x81 #define IN_ENDPOINT2 0x82 #define IN_ENDPOINT3 0x83 #define IN_ENDPOINT4 0x84 #define IN_ENDPOINT5 0x85 #define IN_ENDPOINT6 0x86 +/*! @} */ +/*! @} */ -/* Descriptors structures */ -struct Endpoint_information_st -{ - uint16_t fifo_size ; /* size of the endpoint FIFO */ - uint16_t fifo_left ; -}; -struct USB_request_st -{ - uint8_t bmRequestType; /* Characteristics of the request */ - uint8_t bRequest; /* Specific request */ - uint16_t wValue; /* field that varies according to request */ - uint16_t wIndex; /* field that varies according to request */ - uint16_t wLength; /* Number of bytes to transfer if Data */ -}; - struct usb_st_device_descriptor { uint8_t bLength; /* Size of this descriptor in bytes */ @@ -105,27 +121,16 @@ struct usb_st_configuration_descriptor { - uint8_t bLength; /* size of this descriptor in bytes */ - uint8_t bDescriptorType; /* CONFIGURATION descriptor type */ - uint16_t wTotalLength; /* total length of data returned */ - uint8_t bNumInterfaces; /* number of interfaces for this conf. */ - uint8_t bConfigurationValue; /* value for SetConfiguration resquest */ - uint8_t iConfiguration; /* index of string descriptor */ - uint8_t bmAttibutes; /* Configuration characteristics */ - uint8_t MaxPower; /* maximum power consumption */ + uint8_t bLength; /** size of this descriptor in bytes */ + uint8_t bDescriptorType; /** CONFIGURATION descriptor type */ + uint16_t wTotalLength; /** total length of data returned */ + uint8_t bNumInterfaces; /** number of interfaces for this conf. */ + uint8_t bConfigurationValue; /** value for SetConfiguration resquest */ + uint8_t iConfiguration; /** index of string descriptor */ + uint8_t bmAttibutes; /** Configuration characteristics */ + uint8_t MaxPower; /** maximum power consumption */ }; -struct usb_hid_descriptor -{ - uint8_t bLength; /* size of this descriptor in bytes */ - uint8_t bDescriptorType; /* INTERFACE descriptor type */ - uint16_t bcdHID; /* HID spec. */ - uint8_t bCountryCode; /* Country code value*/ - uint8_t bNumDescriptors; /* Number of reports descriptor */ - uint8_t bDescriptorTypeRep; /* Type of the class-specific descriptor */ - uint16_t wDescriptorLength; /* Size of the report descriptor */ -}; - struct usb_st_interface_descriptor { uint8_t bLength; /* size of this descriptor in bytes */ @@ -213,17 +218,16 @@ uint16_t wstring[AUDIO_NORMAL_LENGTH]; /* language id */ }; - /* HID specific */ -struct usb_st_hid_descriptor -{ - uint8_t bLength; /* Size of this descriptor in bytes */ - uint8_t bDescriptorType; /* HID descriptor type */ - uint16_t bscHID; /* Binay Coded Decimal Spec. release */ - uint8_t bCountryCode; /* Hardware target country */ - uint8_t bNumDescriptors; /* Number of HID class descriptors to follow */ - uint8_t bRDescriptorType; /* Report descriptor type */ - uint16_t wDescriptorLength; /* Total length of Report descriptor */ +struct usb_hid_descriptor +{ + uint8_t bLength; /* size of this descriptor in bytes */ + uint8_t bDescriptorType; /* INTERFACE descriptor type */ + uint16_t bcdHID; /* HID spec. */ + uint8_t bCountryCode; /* Country code value*/ + uint8_t bNumDescriptors; /* Number of reports descriptor */ + uint8_t bDescriptorTypeRep; /* Type of the class-specific descriptor */ + uint16_t wDescriptorLength; /* Size of the report descriptor */ }; /* Audio Class specific */ @@ -262,7 +266,7 @@ uint8_t baInterfaceNr[1]; /* Class code assigned by the USB */ }; -/*_____ U S B I N P U T T E R M I N A L D E S C R I P T O R ___________________________*/ +/* Audio input terminal */ struct usb_Audio_InputTerminal_descriptor { uint8_t bLength; /* size of this descriptor in bytes */ @@ -277,7 +281,7 @@ uint8_t iTerminal; /*Index of a string descriptor, describing the Input Terminal. */ }; -/*_____ U S B O U T P U T T E R M I N A L D E S C R I P T O R ___________________________*/ +/* Audio output terminal */ struct usb_Audio_OutputTerminal_descriptor { uint8_t bLength; /* size of this descriptor in bytes */ @@ -290,7 +294,7 @@ uint8_t iTerminal; /*Index of a string descriptor, describing the Input Terminal. */ }; -/*_____ U S B F E A T U R E U N I T D E S C R I P T O R ___________________________*/ +/* Audio feature unit */ struct usb_Audio_FeatureUnit_descriptor { uint8_t bLength; /* size of this descriptor in bytes */ @@ -303,7 +307,7 @@ uint8_t iFeature; /*Index of a string descriptor, describing this Feature Unit.. */ }; -/*_____ U S B S T D AUDIO STREAM I N T E R F A C E D E S C R I P T O R _____________________*/ +/* Audio stream */ struct usb_Audio_st_ASinterface_descriptor { uint8_t bLength; /* size of this descriptor in bytes */ @@ -317,7 +321,7 @@ uint8_t iInterface; /* Index of string descriptor */ }; -/*_____ U S B C S AUDIO STREAM I N T E R F A C E D E S C R I P T O R _____________________*/ +/* Audio class specific */ struct usb_Audio_cs_ASinterface_descriptor { uint8_t bLength; /* size of this descriptor in bytes */ @@ -328,7 +332,7 @@ uint16_t wFormatTag; /* Class code assigned by the USB */ }; -/*_____ U S B AUDIO ST E N D P O I N T D E S C R I P T O R _______________________*/ +/* Audio EP */ struct usb_Audio_st_endpoint_descriptor { uint8_t bLength; /* Size of this descriptor in bytes */ @@ -341,7 +345,7 @@ uint8_t bSynchAddress; /* The address of the endpoint used to communicate synchronization information if required by this endpoint..*/ }; -/*_____ U S B AUDIO S T E N D P O I N T D E S C R I P T O R _______________________*/ +/* Audio stream */ struct usb_Audio_cs_ASendpoint_descriptor { uint8_t bLength; /* Size of this descriptor in bytes */ @@ -352,7 +356,7 @@ uint16_t wLockDelay; /* Reset to 0.*/ }; -/*_____ U S B AUDIO S T E N D P O I N T D E S C R I P T O R _______________________*/ +/* Audio endpoint */ struct usb_Audio_TYPEI_FormatType_descriptor { uint8_t bLength; /* Size of this descriptor in bytes */ @@ -366,20 +370,29 @@ uint8_t bSamFreqTbl[3]; /*See sampling frequency tables*/ }; +/** \name General structure + * This structure contain all the descriptors. + * @{ */ struct usb_configuration_s -{ +{ + /** Configuration descriptor */ struct usb_st_configuration_descriptor cfg; - //------------------------------------------------------------------------- - // Audio - //------------------------------------------------------------------------- - // Interface 0 :: Audio Control - //------------------------------------------------------------------------- - struct usb_Audio_st_ACinterface_descriptor StandardACInterfaceDescriptor_1; + + /** \name Interface 0 : Audio control + * @{ */ + /** Standard interface descriptor */ + struct usb_Audio_st_ACinterface_descriptor StandardACInterfaceDescriptor_1; + /** Specific interface descriptor */ struct usb_Audio_cs_ACinterface_descriptor SpecificACInterfaceDescriptor; + /** Microphone input terminal */ struct usb_Audio_InputTerminal_descriptor MicInputTerminal1Descriptor; + /** Speaker input terminal */ struct usb_Audio_InputTerminal_descriptor SpkInputTerminalDescriptor; + /** Microphone output terminal */ struct usb_Audio_OutputTerminal_descriptor MicOutputTerminal1Descriptor; + /** Speaker output descriptor */ struct usb_Audio_OutputTerminal_descriptor SpkOutputTerminalDescriptor; + /* @} */ // Interface 1 :: Audio Stream Microphone //------------------------------------------------------------------------- @@ -437,6 +450,7 @@ uint8_t rep[SIZE_OF_REPORT]; #endif }; +/* @} */ extern code struct usb_st_device_descriptor usb_device_descriptor; Modified: firmware/fuxusb/trunk/src/usb_enum.c =================================================================== --- firmware/fuxusb/trunk/src/usb_enum.c 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_enum.c 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,7 +19,7 @@ /* $Id$ */ -/** \file usb_enum.c +/*! \file usb_enum.c \brief Function to control the enumeration process * \ingroup usb_enum */ Modified: firmware/fuxusb/trunk/src/usb_enum.h =================================================================== --- firmware/fuxusb/trunk/src/usb_enum.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_enum.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -21,7 +21,7 @@ /** \file usb_enum.h - \brief Specifics define forthe enumeration process and public defs. + \brief Specifics define for the enumeration process and public defs. \ingroup usb_enum */ @@ -121,9 +121,9 @@ #define AUDIO 0x20 /*! @} */ -void usb_var_init(void); -void usb_ep_init(void); -void usb_enumeration_process(void); +void usb_var_init(void); +void usb_ep_init(void); +void usb_enumeration_process(void); extern uint8_t usb_configuration_nb; Modified: firmware/fuxusb/trunk/src/usb_ep.c =================================================================== --- firmware/fuxusb/trunk/src/usb_ep.c 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_ep.c 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,6 +19,11 @@ /* $Id$ */ +/** \file usb_ep.c + \brief USB Endpoints functions + \ingroup usb_ep +*/ + #include "config.h" #include "usb_ep.h" #include "usb_enum.h" @@ -45,6 +50,7 @@ /** * \brief Parse all endpoints + * \ingroup usb_ep */ void endpoints_parser(void) { @@ -88,7 +94,8 @@ } /** - * \brief Send the statuses previously prepared + * \brief Send the statuses previously prepared. + * \ingroup usb_ep */ void send_status(void) { @@ -107,6 +114,7 @@ * When the EP fifo isn't loaded, 8 bytes are transfered from the MIC fifo to * the EP fifo. * The microphone EP is isochronous with a polling interval of 1ms. + * \ingroup usb_ep */ void fill_mic_ep(void) { @@ -177,6 +185,7 @@ /** * \brief Clear the RX flag of the cmd out EP. + * This function clear the RX flag and control the banks number. */ static void clear_cmdout_ep(void) { @@ -229,6 +238,11 @@ #endif } +/** + * \brief Clear CMD IN endpoint. + * This function clear the TX flag, manage banks number and control if all data + * has been sent. + */ static void clear_cmdin_ep(void) { Usb_select_ep(EP_CMD_IN); Modified: firmware/fuxusb/trunk/src/usb_ep.h =================================================================== --- firmware/fuxusb/trunk/src/usb_ep.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_ep.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,6 +19,11 @@ /* $Id$ */ +/** \file usb_ep.h + \brief USB Endpoints functions + \ingroup usb_ep +*/ + #ifndef _USB_EP_H_ #define _USB_EP_H_ Modified: firmware/fuxusb/trunk/src/usb_misc.c =================================================================== --- firmware/fuxusb/trunk/src/usb_misc.c 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_misc.c 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,6 +19,11 @@ /* $Id$ */ +/** \file usb_misc.c + \brief Misc USB functions. + \ingroup usb_misc +*/ + #include "config.h" #include "global.h" #include "usb_misc.h" @@ -30,6 +35,7 @@ /** * \brief Suspend the USB bus. * This function suspend the bus and keep the rf board on reset state. + * \ingroup usb_misc */ void suspend_usb(void) { @@ -41,6 +47,7 @@ /** * \brief Resume the USB bus. * This function resume the bus afetr a suspend state. + * \ingroup usb_misc */ void resume_usb(void) { @@ -53,6 +60,7 @@ /** * \brief Reset the bus. * This function reset the usb bus. + * \ingroup usb_misc */ void reset_usb(void) { @@ -65,6 +73,7 @@ * \brief reattach USB. * This function simulate a disconnexion/connexion of the USB device. * This is used when the device has to be re-enumerated (ISP mode for example). + * \ingroup usb_misc */ void reattach_usb(void) { Modified: firmware/fuxusb/trunk/src/usb_misc.h =================================================================== --- firmware/fuxusb/trunk/src/usb_misc.h 2008-05-19 11:02:54 UTC (rev 1175) +++ firmware/fuxusb/trunk/src/usb_misc.h 2008-05-20 09:28:43 UTC (rev 1176) @@ -19,6 +19,11 @@ /* $Id$ */ +/** \file usb_misc.h + \brief Misc USB functions. + \ingroup usb_misc +*/ + #ifndef _USB_MISC_H_ #define _USB_MISC_H_ @@ -26,7 +31,6 @@ void resume_usb(void); void reset_usb(void); void reattach_usb(void); -void usb_var_init (void); #endif // _USB_MISC_H_ |
