aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/AT90USBXXX
diff options
context:
space:
mode:
Diffstat (limited to 'LUFA/Drivers/AT90USBXXX')
-rw-r--r--LUFA/Drivers/AT90USBXXX/ADC.h29
-rw-r--r--LUFA/Drivers/AT90USBXXX/AT90USBXXX67/ADC.h12
-rw-r--r--LUFA/Drivers/AT90USBXXX/SPI.h10
-rw-r--r--LUFA/Drivers/AT90USBXXX/Serial.h10
-rw-r--r--LUFA/Drivers/AT90USBXXX/Serial_Stream.h11
5 files changed, 70 insertions, 2 deletions
diff --git a/LUFA/Drivers/AT90USBXXX/ADC.h b/LUFA/Drivers/AT90USBXXX/ADC.h
index 341b4e194..12e168834 100644
--- a/LUFA/Drivers/AT90USBXXX/ADC.h
+++ b/LUFA/Drivers/AT90USBXXX/ADC.h
@@ -35,6 +35,10 @@
* User code should include this file, which will in turn include the correct ADC driver header file for the
* currently selected AVR model.
*/
+
+/** \ingroup Group_SubsystemDrivers
+ * @defgroup Group_ADC ADC Driver - LUFA/Drivers/AT90USBXXX/ADC.h
+ */
#ifndef __ADC_H__
#define __ADC_H__
@@ -55,4 +59,29 @@
#error "ADC is not available for the currently selected AVR model."
#endif
+ /* Public Interface - May be used in end-application: */
+ /* Inline Functions: */
+ /** Starts the reading of the given channel, but does not wait until the conversion has completed.
+ * Once executed, the conversion status can be determined via the ADC_IsReadingComplete() macro and
+ * the result read via the ADC_GetResult() macro.
+ *
+ * \param MUXMask Mask comprising of an ADC channel number, reference mask and adjustment mask
+ */
+ static inline void ADC_StartReading(const uint8_t MUXMask);
+
+ /** Performs a complete single reading from channel, including a polling spinloop to wait for the
+ * conversion to complete, and the returning of the converted value.
+ *
+ * \param MUXMask Mask comprising of an ADC channel number, reference mask and adjustment mask
+ */
+ static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask) ATTR_WARN_UNUSED_RESULT;
+
+ /** Configures the given ADC channel, ready for ADC conversions. This function sets the
+ * associated port pin as an input and disables the digital portion of the I/O to reduce
+ * power consumption.
+ *
+ * \param Channel ADC channel number to set up for conversions
+ */
+ static inline void ADC_SetupChannel(const uint8_t Channel);
+
#endif
diff --git a/LUFA/Drivers/AT90USBXXX/AT90USBXXX67/ADC.h b/LUFA/Drivers/AT90USBXXX/AT90USBXXX67/ADC.h
index c86203fe0..c6169c18a 100644
--- a/LUFA/Drivers/AT90USBXXX/AT90USBXXX67/ADC.h
+++ b/LUFA/Drivers/AT90USBXXX/AT90USBXXX67/ADC.h
@@ -36,15 +36,21 @@
* dispatch header located in LUFA/Drivers/AT90USBXXX/ADC.h.
*/
+/** \ingroup Group_ADC
+ * @defgroup Group_ADC_AT90USBXXX67 AT90USBXXX6 and AT90USBXXX7 Models
+ *
+ * @{
+ */
+
#ifndef __ADC_AT90USBXXX67_H__
#define __ADC_AT90USBXXX67_H__
/* Includes: */
+ #include "../../../Common/Common.h"
+
#include <avr/io.h>
#include <stdbool.h>
- #include "../../../Common/Common.h"
-
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
@@ -175,3 +181,5 @@
#endif
#endif
+
+/** @} */
diff --git a/LUFA/Drivers/AT90USBXXX/SPI.h b/LUFA/Drivers/AT90USBXXX/SPI.h
index d1c9cede4..f0b43e0df 100644
--- a/LUFA/Drivers/AT90USBXXX/SPI.h
+++ b/LUFA/Drivers/AT90USBXXX/SPI.h
@@ -33,6 +33,14 @@
* Hardware SPI subsystem driver for the supported USB AVRs models.
*/
+/** \ingroup Group_SubsystemDrivers
+ * @defgroup Group_SPI SPI Driver - LUFA/Drivers/AT90USBXXX/SPI.h
+ *
+ * Functions, macros, variables, enums and types related to the setup of a the SPI port.
+ *
+ * @{
+ */
+
#ifndef __SPI_H__
#define __SPI_H__
@@ -137,3 +145,5 @@
#endif
#endif
+
+/** @} */
diff --git a/LUFA/Drivers/AT90USBXXX/Serial.h b/LUFA/Drivers/AT90USBXXX/Serial.h
index bbf3044fa..f08f9a039 100644
--- a/LUFA/Drivers/AT90USBXXX/Serial.h
+++ b/LUFA/Drivers/AT90USBXXX/Serial.h
@@ -33,6 +33,14 @@
* Driver for the USART subsystem on supported USB AVRs.
*/
+/** \ingroup Group_SubsystemDrivers
+ * @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/AT90USBXXX/Serial.h
+ *
+ * Functions, macros, variables, enums and types related to the setup of the USART for serial communications.
+ *
+ * @{
+ */
+
#ifndef __SERIAL_H__
#define __SERIAL_H__
@@ -113,3 +121,5 @@
#endif
#endif
+
+/** @} */
diff --git a/LUFA/Drivers/AT90USBXXX/Serial_Stream.h b/LUFA/Drivers/AT90USBXXX/Serial_Stream.h
index adde5b95e..d5034bb53 100644
--- a/LUFA/Drivers/AT90USBXXX/Serial_Stream.h
+++ b/LUFA/Drivers/AT90USBXXX/Serial_Stream.h
@@ -35,6 +35,15 @@
* USART.
**/
+/** \ingroup Group_SubsystemDrivers
+ * @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/AT90USBXXX/Serial_Stream.h
+ *
+ * Functions, macros, variables, enums and types related to the setup of a serial stream, so that standard printf and other
+ * C stream functions can be used on the serial port.
+ *
+ * @{
+ */
+
#ifndef __SERIAL_STREAM_H__
#define __SERIAL_STREAM_H__
@@ -80,3 +89,5 @@
#endif
#endif
+
+/** @} */