diff options
Diffstat (limited to 'LUFA/Drivers/USB/Class/Host/Printer.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/Printer.h | 66 | 
1 files changed, 33 insertions, 33 deletions
| diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 89f229975f..5c6f74a6d8 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -79,11 +79,11 @@  			{  				const struct  				{ -					uint8_t  DataINPipeNumber; /**< Pipe number of the Printer interface's IN data pipe */ -					bool     DataINPipeDoubleBank; /**< Indicates if the Printer interface's IN data pipe should use double banking */ +					uint8_t  DataINPipeNumber; /**< Pipe number of the Printer interface's IN data pipe. */ +					bool     DataINPipeDoubleBank; /**< Indicates if the Printer interface's IN data pipe should use double banking. */ -					uint8_t  DataOUTPipeNumber; /**< Pipe number of the Printer interface's OUT data pipe */ -					bool     DataOUTPipeDoubleBank; /**< Indicates if the Printer interface's OUT data pipe should use double banking */ +					uint8_t  DataOUTPipeNumber; /**< Pipe number of the Printer interface's OUT data pipe. */ +					bool     DataOUTPipeDoubleBank; /**< Indicates if the Printer interface's OUT data pipe should use double banking. */  				} Config; /**< Config data for the USB class interface within the device. All elements in this section  				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.  				           */ @@ -91,13 +91,13 @@  				{  					bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid  					                *   after \ref PRNT_Host_ConfigurePipes() is called and the Host state machine is in the -					                *   Configured state +					                *   Configured state.  					                */ -					uint8_t InterfaceNumber; /**< Interface index of the Printer interface within the attached device */ -					uint8_t AlternateSetting; /**< Alternate setting within the Printer Interface in the attached device */ +					uint8_t InterfaceNumber; /**< Interface index of the Printer interface within the attached device. */ +					uint8_t AlternateSetting; /**< Alternate setting within the Printer Interface in the attached device. */ -					uint16_t DataINPipeSize; /**< Size in bytes of the Printer interface's IN data pipe */ -					uint16_t DataOUTPipeSize;  /**< Size in bytes of the Printer interface's OUT data pipe */ +					uint16_t DataINPipeSize; /**< Size in bytes of the Printer interface's IN data pipe. */ +					uint16_t DataOUTPipeSize;  /**< Size in bytes of the Printer interface's OUT data pipe. */  				} State; /**< State data for the USB class interface within the device. All elements in this section  						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when  						  *   the interface is enumerated. @@ -107,10 +107,10 @@  		/* Enums: */  			enum PRNTHost_EnumerationFailure_ErrorCodes_t  			{ -				PRNT_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */ -				PRNT_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */ -				PRNT_ENUMERROR_NoPrinterInterfaceFound    = 2, /**< A compatible Printer interface was not found in the device's Configuration Descriptor */ -				PRNT_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Printer endpoints were not found in the device's interfaces */ +				PRNT_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */ +				PRNT_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */ +				PRNT_ENUMERROR_NoPrinterInterfaceFound    = 2, /**< A compatible Printer interface was not found in the device's Configuration Descriptor. */ +				PRNT_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Printer endpoints were not found in the device's interfaces. */  			};  		/* Function Prototypes: */ @@ -120,11 +120,11 @@  			 *  the device. This should be called once after the stack has enumerated the attached device, while the host state  			 *  machine is in the Addressed state.  			 * -			 *  \param[in,out] PRNTInterfaceInfo       Pointer to a structure containing a Printer Class host configuration and state -			 *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor -			 *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor +			 *  \param[in,out] PRNTInterfaceInfo       Pointer to a structure containing a Printer Class host configuration and state. +			 *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor. +			 *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.  			 * -			 *  \return A value from the \ref PRNTHost_EnumerationFailure_ErrorCodes_t enum +			 *  \return A value from the \ref PRNTHost_EnumerationFailure_ErrorCodes_t enum.  			 */  			uint8_t PRNT_Host_ConfigurePipes(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, uint16_t ConfigDescriptorSize,  			                                 void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3); @@ -132,28 +132,28 @@  			/** Configures the printer to enable Bidirectional mode, if it is not already in this mode. This should be called  			 *  once the connected device's configuration has been set, to ensure the printer is ready to accept commands.  			 * -			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state +			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.  			 * -			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum +			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.  			 */  			uint8_t PRNT_Host_SetBidirectionalMode(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  			/** Retrieves the status of the virtual Printer port's inbound status lines. The result can then be masked against the  			 *  PRNT_PORTSTATUS_* macros to determine the printer port's status.  			 * -			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state -			 *  \param[out]    PortStatus         Location where the retrieved port status should be stored +			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state. +			 *  \param[out]    PortStatus         Location where the retrieved port status should be stored.  			 * -			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum +			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.  			 */  			uint8_t PRNT_Host_GetPortStatus(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, uint8_t* const PortStatus)  			                                ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  			/** Soft-resets the attached printer, readying it for new commands.  			 * -			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state +			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.  			 * -			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum +			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.  			 */  			uint8_t PRNT_Host_SoftReset(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -164,11 +164,11 @@  			 *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the  			 *       call will fail.  			 * -			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state -			 *  \param[in]     PrinterCommands    Pointer to a buffer containing the raw command stream to send to the printer -			 *  \param[in]     CommandSize        Size in bytes of the command stream to be sent +			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state. +			 *  \param[in]     PrinterCommands    Pointer to a buffer containing the raw command stream to send to the printer. +			 *  \param[in]     CommandSize        Size in bytes of the command stream to be sent.  			 * -			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum +			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  			 */  			uint8_t PRNT_Host_SendData(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, void* PrinterCommands,   			                           uint16_t CommandSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); @@ -180,11 +180,11 @@  			 *  			 *  This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.  			 * -			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state -			 *  \param[out]    DeviceIDString     Pointer to a buffer where the Device ID string should be stored, in ASCII format -			 *  \param[in]     BufferSize         Size in bytes of the buffer allocated for the Device ID string +			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state. +			 *  \param[out]    DeviceIDString     Pointer to a buffer where the Device ID string should be stored, in ASCII format. +			 *  \param[in]     BufferSize         Size in bytes of the buffer allocated for the Device ID string.  			 * -			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum +			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  			 */  			uint8_t PRNT_Host_GetDeviceID(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, char* DeviceIDString,  			                              uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); @@ -194,7 +194,7 @@  			 *  the interface. This should be called frequently in the main program loop, before the master USB management task  			 *  \ref USB_USBTask().  			 * -			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state +			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.  			 */  			static inline void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  			static inline void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) | 
