/** Bluetooth stack callback event for a Bluetooth connection request. When this callback fires, the\r
* user application must indicate if the connection is to be allowed or rejected.\r
*\r
- * \param RemoteAddress Bluetooth address of the remote device attempting the connection\r
+ * \param[in] RemoteAddress Bluetooth address of the remote device attempting the connection\r
*\r
* \return Boolean true to accept the connection, false to reject it\r
*/\r
/** Bluetooth stack callback event for a non-signal ACL packet reception. This callback fires once a connection\r
* to a remote Bluetooth device has been made, and the remote device has sent a non-signalling ACL packet.\r
*\r
- * \param Data Pointer to a buffer where the received data is stored\r
- * \param DataLen Length of the packet data, in bytes\r
- * \param Channel Bluetooth ACL data channel information structure for the packet's destination channel\r
+ * \param[in] Data Pointer to a buffer where the received data is stored\r
+ * \param[in] DataLen Length of the packet data, in bytes\r
+ * \param[in] Channel Bluetooth ACL data channel information structure for the packet's destination channel\r
*/\r
void Bluetooth_PacketReceived(void* Data, uint16_t DataLen, Bluetooth_Channel_t* Channel)\r
{\r
\r
/** Sends a packet to the remote device on the specified channel.\r
*\r
- * \param Data Pointer to a buffer where the data is to be sourced from\r
- * \param DataLen Length of the data to send\r
- * \param Channel Channel information structure containing the destination channel's information, NULL to send\r
- * to the remote device's signalling channel\r
+ * \param[in] Data Pointer to a buffer where the data is to be sourced from\r
+ * \param[in] DataLen Length of the data to send\r
+ * \param[in] Channel Channel information structure containing the destination channel's information, NULL to send\r
+ * to the remote device's signalling channel\r
*\r
* \return A value from the \ref BT_SendPacket_ErrorCodes_t enum\r
*/\r
* repeatedly called. The returned channel is unusable by the user application until its State\r
* element has progressed to the Open state.\r
*\r
- * \param PSM PSM of the service that the channel is to be opened for\r
+ * \param[in] PSM PSM of the service that the channel is to be opened for\r
*\r
* \return Pointer to the channel information structure of the opened channel, or NULL if no free channels\r
*/\r
* returned channel is unusable by the user application upon return however the channel is not completely\r
* closed until its State element has progressed to the Closed state.\r
*\r
- * \param Channel Channel information structure of the channel to close\r
+ * \param[in,out] Channel Channel information structure of the channel to close\r
*/\r
void Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for a Connection Request command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_ConnectionReq(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for a Connection Response command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_ConnectionResp(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for a Configuration Request command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_ConfigurationReq(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for a Configuration Response command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_ConfigurationResp(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for a Disconnection Request command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_DisconnectionReq(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for a Disconnection Response command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_DisconnectionResp(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for an Echo Request command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_EchoReq(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Internal Bluetooth stack Signal Command processing routine for an Information Request command.\r
*\r
- * \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
+ * \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header\r
*/\r
static inline void Bluetooth_Signal_InformationReq(BT_Signal_Header_t* SignalCommandHeader)\r
{\r
\r
/** Sends a Bluetooth HCI control command to the attached Bluetooth device.\r
*\r
- * \param HCICommandHeader HCI command header to send to the attached device\r
- * \param Parameters Pointer to the source of the control parameters (if any)\r
- * \param ParameterLength Length of the parameters to send in bytes\r
+ * \param[in] HCICommandHeader HCI command header to send to the attached device\r
+ * \param[in] Parameters Pointer to the source of the control parameters (if any)\r
+ * \param[in] ParameterLength Length of the parameters to send in bytes\r
*\r
* \return A value from the USB_Host_SendControlErrorCodes_t enum.\r
*/\r
\r
/** Retrieves the channel information structure with the given local or remote channel number from the channel list.\r
*\r
- * \param ChannelNumber Channel number to search for in the channel list\r
- * \param SearchByRemoteChannel Indicated whether to search for a channel information structure by the given remote channel\r
- * or local channel number\r
+ * \param[in] ChannelNumber Channel number to search for in the channel list\r
+ * \param[in] SearchByRemoteChannel Indicated whether to search for a channel information structure by the given remote channel\r
+ * or local channel number\r
*\r
* \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise\r
*/\r
#endif\r
\r
/** Places the function in one of the initialization sections, which execute before the main function\r
- * of the application. The init function number can be specified as "x", as an integer. Refer to the\r
- * avr-libc manual for more information on the initialization sections.\r
+ * of the application. Refer to the avr-libc manual for more information on the initialization sections.\r
+ *\r
+ * \param[in] x Initialization section number where the function should be placed\r
*/\r
#define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x )))\r
\r
- /** Marks a function as an alias for another function of name "x". */\r
+ /** Marks a function as an alias for another function.\r
+ *\r
+ * \param[in] x Name of the function which the given function name should alias\r
+ */\r
#define ATTR_ALIAS(x) __attribute__ ((alias( #x )))\r
#endif\r
\r
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,\r
# corresponding to a cache size of 2^16 = 65536 symbols\r
\r
-SYMBOL_CACHE_SIZE = 0\r
+SYMBOL_CACHE_SIZE = 1\r
\r
#---------------------------------------------------------------------------\r
# Build related configuration options\r
# directories that contain example code fragments that are included (see\r
# the \include command).\r
\r
-EXAMPLE_PATH =\r
+EXAMPLE_PATH = ../\r
\r
# If the value of the EXAMPLE_PATH tag contains directories, you can use the\r
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp\r
--- /dev/null
+Permission to use, copy, modify, and distribute this software\r
+and its documentation for any purpose is hereby granted without\r
+fee, provided that the above copyright notice appear in all\r
+copies and that both that the copyright notice and this\r
+permission notice and warranty disclaimer appear in supporting\r
+documentation, and that the name of the author not be used in\r
+advertising or publicity pertaining to distribution of the\r
+software without specific, written prior permission.\r
+\r
+The author disclaim all warranties with regard to this\r
+software, including all implied warranties of merchantability\r
+and fitness. In no event shall the author be liable for any\r
+special, indirect or consequential damages or any damages\r
+whatsoever resulting from loss of use, data or profits, whether\r
+in an action of contract, negligence or other tortious action,\r
+arising out of or in connection with the use or performance of\r
+this software.\r
* donations are <i>greatly</i> appreciated.\r
*\r
* Note that commercial entities can remove the attribution portion of the LUFA licence by a one-time fee - see\r
- * \ref Page_Licence for more details (<b>Note: Please do NOT pay this in advance through the donation link below -\r
+ * \ref Page_LicenceInfo for more details (<b>Note: Please do NOT pay this in advance through the donation link below -\r
* contact author for payment details.</b>).\r
*\r
* \image html "http://www.pledgie.com/campaigns/6927.png?skin_name=chrome"\r
* official Atmel USB stack. Below are just some of the advantages to choosing LUFA over the official stack.\r
*\r
* - <b>Licensing:</b>\r
- * LUFA is released under a very permissive MIT license (see \ref Page_Licence), while the Atmel stack carries several\r
+ * LUFA is released under a very permissive MIT license (see \ref Page_LicenceInfo), while the Atmel stack carries several\r
* restrictions as to how and where it can be used. LUFA's licensing should be suitable for both Commercial and Non-Commercial\r
* entities alike.\r
*\r
+++ /dev/null
-/** \file\r
- *\r
- * This file contains special DoxyGen information for the generation of the main page and other special\r
- * documentation pages. It is not a project source file.\r
- */\r
-\r
-/**\r
- * \page Page_Licence Source Code Licence\r
- *\r
- * The LUFA library is currently released under the MIT licence, included below.\r
- *\r
- * Commercial entities can opt out of the public disclosure clause in this license\r
- * for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which\r
- * allows for the free use of the LUFA library, bootloaders and (where the sole copyright\r
- * is attributed to Dean Camera) demos without public disclosure within an organisation, in\r
- * addition to three free hours of consultation with the library author, and priority support.\r
- * Please contact the author for more information via the address shown on on \ref Page_Resources.\r
- *\r
- * \verbatim\r
- * Permission to use, copy, modify, and distribute this software\r
- * and its documentation for any purpose is hereby granted without\r
- * fee, provided that the above copyright notice appear in all\r
- * copies and that both that the copyright notice and this\r
- * permission notice and warranty disclaimer appear in supporting\r
- * documentation, and that the name of the author not be used in\r
- * advertising or publicity pertaining to distribution of the\r
- * software without specific, written prior permission.\r
- *\r
- * The author disclaim all warranties with regard to this\r
- * software, including all implied warranties of merchantability\r
- * and fitness. In no event shall the author be liable for any\r
- * special, indirect or consequential damages or any damages\r
- * whatsoever resulting from loss of use, data or profits, whether\r
- * in an action of contract, negligence or other tortious action,\r
- * arising out of or in connection with the use or performance of\r
- * this software.\r
- * \endverbatim\r
- */\r
--- /dev/null
+/** \file\r
+ *\r
+ * This file contains special DoxyGen information for the generation of the main page and other special\r
+ * documentation pages. It is not a project source file.\r
+ */\r
+\r
+/**\r
+ * \page Page_LicenceInfo Source Code Licence\r
+ *\r
+ * The LUFA library is currently released under the MIT licence, included below.\r
+ *\r
+ * Commercial entities can opt out of the public disclosure clause in this license\r
+ * for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which\r
+ * allows for the free use of the LUFA library, bootloaders and (where the sole copyright\r
+ * is attributed to Dean Camera) demos without public disclosure within an organisation, in\r
+ * addition to three free hours of consultation with the library author, and priority support.\r
+ * Please contact the author for more information via the address shown on on \ref Page_Resources.\r
+ *\r
+ * \verbinclude License.txt\r
+ */\r
*\r
* <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>\r
*\r
- * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_Licence).\r
+ * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenceInfo).\r
* It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,\r
* feature rich framework for the development of USB peripherals and hosts.\r
*\r
* - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?\r
* - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?\r
* - \subpage Page_AlternativeStacks Alternative USB AVR Stacks\r
- * - \subpage Page_Licence Project source licence and commercial use information\r
+ * - \subpage Page_LicenceInfo Project source licence and commercial use information\r
* - \subpage Page_Donating Donating to support this project\r
* - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects\r
*/\r
* #define MAGIC_BOOT_KEY 0xDC42ACCA\r
* #define BOOTLOADER_START_ADDRESS ({FLASH_SIZE_BYTES} - {BOOTLOADER_SEC_SIZE_BYTES})\r
* \r
- * int Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3);\r
- * int Bootloader_Jump_Check(void)\r
+ * void Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3);\r
+ * void Bootloader_Jump_Check(void)\r
* {\r
* // If the bootloader key is correct, clear it and jump to the bootloader\r
* if (Boot_Key == MAGIC_BOOT_KEY)\r
projects / pub / lufa.git / commitdiff