Add FatFS library to the Webserver project, extend the HTTP server so that it now...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / Printer.h
index 92b0a3d..06a1f84 100644 (file)
@@ -1,21 +1,21 @@
 /*\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
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, 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
+  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
+  without fee, provided that the above copyright notice appear in \r
+  all 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
                        };\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
                         *  \return A value from the \ref PRNTHost_EnumerationFailure_ErrorCodes_t enum\r
                         */\r
                        uint8_t PRNT_Host_ConfigurePipes(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, uint16_t ConfigDescriptorSize,\r
-                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(13);\r
+                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
                        \r
                        /** Configures the printer to enable Bidirectional mode, if it is not already in this mode. This should be called\r
                         *  once the connected device's configuration has been set, to ensure the printer is ready to accept commands.\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
                         */\r
                        uint8_t PRNT_Host_GetPortStatus(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, uint8_t* const PortStatus)\r
-                                                       ATTR_NON_NULL_PTR_ARG(12);\r
+                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
 \r
                        /** Soft-resets the attached printer, readying it for new commands.\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
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\r
                        uint8_t PRNT_Host_SendData(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, void* PrinterCommands, \r
-                                                  uint16_t CommandSize) ATTR_NON_NULL_PTR_ARG(12);\r
+                                                  uint16_t CommandSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
 \r
                        /** Retrieves the attached printer device's ID string, formatted according to IEEE 1284. This string is sent as a\r
                         *  Unicode string from the device and is automatically converted to an ASCII encoded C string by this function, thus\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