Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / Printer.h

diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h
index 0de94e6..04286ca 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/Printer.h
+++ b/LUFA/Drivers/USB/Class/Host/Printer.h
@@ -1,13 +1,13 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r


@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB Printer Class driver.\r
+ *\r
+ *  Host mode driver for the library USB Printer Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/Printer.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassPrinter\r
  *  @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassPrinter\r
  *  @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver\r
  *\r


@@ -53,11 +62,16 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_PRINTER_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/Printer.h instead.\r
+               #endif\r
+\r

        /* Public Interface - May be used in end-application: */\r
        /* Public Interface - May be used in end-application: */\r

-               /* Macros: */\r
-       \r

                /* Type Defines: */\r
                /* Type Defines: */\r

-                       /** Class state structure. An instance of this structure should be made within the user application,\r
+                       /** \brief Printer Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r

                         *  and passed to each of the Printer class driver functions as the PRNTInterfaceInfo parameter. This\r
                         *  stores each Printer interface's configuration and state information.\r
                         */\r
                         *  and passed to each of the Printer class driver functions as the PRNTInterfaceInfo parameter. This\r
                         *  stores each Printer interface's configuration and state information.\r
                         */\r


@@ -100,15 +114,6 @@
                        };\r
        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\r

-                       /** General management task for a given Printer host class interface, required for the correct operation of\r
-                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
-                        *  \ref USB_USBTask().\r
-                        *\r
-                        *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state\r
-                        */\r
-                       void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-                       \r
-\r

                        /** Host interface configuration routine, to configure a given Printer host interface instance using the\r
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Printer\r
                         *  instance's state values and configures the pipes required to communicate with the interface if it is found within\r
                        /** Host interface configuration routine, to configure a given Printer host interface instance using the\r
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Printer\r
                         *  instance's state values and configures the pipes required to communicate with the interface if it is found within\r


@@ -156,6 +161,9 @@
                         *  printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see\r
                         *  \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.\r
                         *\r
                         *  printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see\r
                         *  \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.\r
                         *\r

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r

                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state\r
                         *  \param[in] PrinterCommands  Pointer to a buffer containing the raw command stream to send to the printer\r
                         *  \param[in] CommandSize  Size in bytes of the command stream to be sent\r
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state\r
                         *  \param[in] PrinterCommands  Pointer to a buffer containing the raw command stream to send to the printer\r
                         *  \param[in] CommandSize  Size in bytes of the command stream to be sent\r


@@ -181,6 +189,19 @@
                        uint8_t PRNT_Host_GetDeviceID(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, char* DeviceIDString,\r
                                                      uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        uint8_t PRNT_Host_GetDeviceID(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, char* DeviceIDString,\r
                                                      uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1);\r
 \r

+               /* Inline Functions: */\r
+                       /** General management task for a given Printer host class interface, required for the correct operation of\r
+                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state\r
+                        */\r
+                       static inline void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo);\r
+                       static inline void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo)\r
+                       {\r
+                               (void)PRNTInterfaceInfo;\r
+                       }\r
+\r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r


@@ -196,7 +217,7 @@
                        #define PRNT_FOUND_DATAPIPE_OUT        (1 << 1)\r
                        \r
                /* Function Prototypes: */\r
                        #define PRNT_FOUND_DATAPIPE_OUT        (1 << 1)\r
                        \r
                /* Function Prototypes: */\r

-                       #if defined(INCLUDE_FROM_PRINTER_CLASS_HOST_C)          \r
+                       #if defined(__INCLUDE_FROM_PRINTER_CLASS_HOST_C)                \r

                                static uint8_t DComp_NextPRNTInterface(void* const CurrentDescriptor);\r
                                static uint8_t DComp_NextPRNTInterfaceEndpoint(void* const CurrentDescriptor);\r
                        #endif\r
                                static uint8_t DComp_NextPRNTInterface(void* const CurrentDescriptor);\r
                                static uint8_t DComp_NextPRNTInterfaceEndpoint(void* const CurrentDescriptor);\r
                        #endif\r