Add new Printer Device Class driver.
This commit is contained in:
		
							parent
							
								
									7f5445c8c6
								
							
						
					
					
						commit
						9ccf3eafad
					
				
					 6 changed files with 598 additions and 15 deletions
				
			
		
							
								
								
									
										297
									
								
								LUFA/Drivers/USB/Class/Device/PrinterClassDevice.c
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										297
									
								
								LUFA/Drivers/USB/Class/Device/PrinterClassDevice.c
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,297 @@ | |||
| /*
 | ||||
|              LUFA Library | ||||
|      Copyright (C) Dean Camera, 2013. | ||||
| 
 | ||||
|   dean [at] fourwalledcubicle [dot] com | ||||
|            www.lufa-lib.org | ||||
| */ | ||||
| 
 | ||||
| /*
 | ||||
|   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com) | ||||
| 
 | ||||
|   Permission to use, copy, modify, distribute, and sell this | ||||
|   software and its documentation for any purpose is hereby granted | ||||
|   without fee, provided that the above copyright notice appear in | ||||
|   all copies and that both that the copyright notice and this | ||||
|   permission notice and warranty disclaimer appear in supporting | ||||
|   documentation, and that the name of the author not be used in | ||||
|   advertising or publicity pertaining to distribution of the | ||||
|   software without specific, written prior permission. | ||||
| 
 | ||||
|   The author disclaims all warranties with regard to this | ||||
|   software, including all implied warranties of merchantability | ||||
|   and fitness.  In no event shall the author be liable for any | ||||
|   special, indirect or consequential damages or any damages | ||||
|   whatsoever resulting from loss of use, data or profits, whether | ||||
|   in an action of contract, negligence or other tortious action, | ||||
|   arising out of or in connection with the use or performance of | ||||
|   this software. | ||||
| */ | ||||
| 
 | ||||
| #define  __INCLUDE_FROM_USB_DRIVER | ||||
| #include "../../Core/USBMode.h" | ||||
| 
 | ||||
| #if defined(USB_CAN_BE_DEVICE) | ||||
| 
 | ||||
| #define  __INCLUDE_FROM_PRINTER_DRIVER | ||||
| #define  __INCLUDE_FROM_PRINTER_DEVICE_C | ||||
| #include "PrinterClassDevice.h" | ||||
| 
 | ||||
| void PRNT_Device_ProcessControlRequest(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| { | ||||
| 	if (!(Endpoint_IsSETUPReceived())) | ||||
| 	  return; | ||||
| 
 | ||||
| 	if (USB_ControlRequest.wIndex != PRNTInterfaceInfo->Config.InterfaceNumber) | ||||
| 	  return; | ||||
| 
 | ||||
| 	switch (USB_ControlRequest.bRequest) | ||||
| 	{ | ||||
| 		case PRNT_REQ_GetDeviceID: | ||||
| 			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) | ||||
| 			{ | ||||
| 				Endpoint_ClearSETUP(); | ||||
| 
 | ||||
| 				while (!(Endpoint_IsINReady())) | ||||
| 				{ | ||||
| 					if (USB_DeviceState == DEVICE_STATE_Unattached) | ||||
| 					  return; | ||||
| 				} | ||||
| 
 | ||||
| 				uint16_t IEEEStringLen = strlen(PRNTInterfaceInfo->Config.IEEE1284String); | ||||
| 				Endpoint_Write_16_BE(IEEEStringLen + 1); | ||||
| 				Endpoint_Write_Control_Stream_LE(PRNTInterfaceInfo->Config.IEEE1284String, IEEEStringLen); | ||||
| 				Endpoint_ClearStatusStage(); | ||||
| 			} | ||||
| 
 | ||||
| 			break; | ||||
| 		case PRNT_REQ_GetPortStatus: | ||||
| 			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) | ||||
| 			{ | ||||
| 				Endpoint_ClearSETUP(); | ||||
| 
 | ||||
| 				while (!(Endpoint_IsINReady())) | ||||
| 				{ | ||||
| 					if (USB_DeviceState == DEVICE_STATE_Unattached) | ||||
| 					  return; | ||||
| 				} | ||||
| 
 | ||||
| 				Endpoint_Write_8(PRNTInterfaceInfo->State.PortStatus); | ||||
| 				Endpoint_ClearStatusStage(); | ||||
| 			} | ||||
| 
 | ||||
| 			break; | ||||
| 		case PRNT_REQ_SoftReset: | ||||
| 			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE)) | ||||
| 			{ | ||||
| 				Endpoint_ClearSETUP(); | ||||
| 				Endpoint_ClearStatusStage(); | ||||
| 
 | ||||
| 				EVENT_PRNT_Device_SoftReset(PRNTInterfaceInfo); | ||||
| 			} | ||||
| 
 | ||||
| 			break; | ||||
| 	} | ||||
| } | ||||
| 
 | ||||
| bool PRNT_Device_ConfigureEndpoints(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| { | ||||
| 	memset(&PRNTInterfaceInfo->State, 0x00, sizeof(PRNTInterfaceInfo->State)); | ||||
| 	PRNTInterfaceInfo->State.PortStatus = PRNT_PORTSTATUS_NOTERROR | PRNT_PORTSTATUS_SELECT; | ||||
| 
 | ||||
| 	PRNTInterfaceInfo->Config.DataINEndpoint.Type  = EP_TYPE_BULK; | ||||
| 	PRNTInterfaceInfo->Config.DataOUTEndpoint.Type = EP_TYPE_BULK; | ||||
| 
 | ||||
| 	if (!(Endpoint_ConfigureEndpointTable(&PRNTInterfaceInfo->Config.DataINEndpoint, 1))) | ||||
| 	  return false; | ||||
| 
 | ||||
| 	if (!(Endpoint_ConfigureEndpointTable(&PRNTInterfaceInfo->Config.DataOUTEndpoint, 1))) | ||||
| 	  return false; | ||||
| 
 | ||||
| 	return true; | ||||
| } | ||||
| 
 | ||||
| void PRNT_Device_USBTask(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return; | ||||
| 
 | ||||
| 	#if !defined(NO_CLASS_DRIVER_AUTOFLUSH) | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataINEndpoint.Address); | ||||
| 
 | ||||
| 	if (Endpoint_IsINReady()) | ||||
| 	  PRNT_Device_Flush(PRNTInterfaceInfo); | ||||
| 	#endif | ||||
| } | ||||
| 
 | ||||
| uint8_t PRNT_Device_SendString(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
|                                const char* const String) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return ENDPOINT_RWSTREAM_DeviceDisconnected; | ||||
| 
 | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataINEndpoint.Address); | ||||
| 	return Endpoint_Write_Stream_LE(String, strlen(String), NULL); | ||||
| } | ||||
| 
 | ||||
| uint8_t PRNT_Device_SendData(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
|                              const void* const Buffer, | ||||
|                              const uint16_t Length) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return ENDPOINT_RWSTREAM_DeviceDisconnected; | ||||
| 
 | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataINEndpoint.Address); | ||||
| 	return Endpoint_Write_Stream_LE(Buffer, Length, NULL); | ||||
| } | ||||
| 
 | ||||
| uint8_t PRNT_Device_SendByte(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
|                              const uint8_t Data) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return ENDPOINT_RWSTREAM_DeviceDisconnected; | ||||
| 
 | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataINEndpoint.Address); | ||||
| 
 | ||||
| 	if (!(Endpoint_IsReadWriteAllowed())) | ||||
| 	{ | ||||
| 		Endpoint_ClearIN(); | ||||
| 
 | ||||
| 		uint8_t ErrorCode; | ||||
| 
 | ||||
| 		if ((ErrorCode = Endpoint_WaitUntilReady()) != ENDPOINT_READYWAIT_NoError) | ||||
| 		  return ErrorCode; | ||||
| 	} | ||||
| 
 | ||||
| 	Endpoint_Write_8(Data); | ||||
| 	return ENDPOINT_READYWAIT_NoError; | ||||
| } | ||||
| 
 | ||||
| uint8_t PRNT_Device_Flush(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return ENDPOINT_RWSTREAM_DeviceDisconnected; | ||||
| 
 | ||||
| 	uint8_t ErrorCode; | ||||
| 
 | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataINEndpoint.Address); | ||||
| 
 | ||||
| 	if (!(Endpoint_BytesInEndpoint())) | ||||
| 	  return ENDPOINT_READYWAIT_NoError; | ||||
| 
 | ||||
| 	bool BankFull = !(Endpoint_IsReadWriteAllowed()); | ||||
| 
 | ||||
| 	Endpoint_ClearIN(); | ||||
| 
 | ||||
| 	if (BankFull) | ||||
| 	{ | ||||
| 		if ((ErrorCode = Endpoint_WaitUntilReady()) != ENDPOINT_READYWAIT_NoError) | ||||
| 		  return ErrorCode; | ||||
| 
 | ||||
| 		Endpoint_ClearIN(); | ||||
| 	} | ||||
| 
 | ||||
| 	return ENDPOINT_READYWAIT_NoError; | ||||
| } | ||||
| 
 | ||||
| uint16_t PRNT_Device_BytesReceived(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return 0; | ||||
| 
 | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataOUTEndpoint.Address); | ||||
| 
 | ||||
| 	if (Endpoint_IsOUTReceived()) | ||||
| 	{ | ||||
| 		if (!(Endpoint_BytesInEndpoint())) | ||||
| 		{ | ||||
| 			Endpoint_ClearOUT(); | ||||
| 			return 0; | ||||
| 		} | ||||
| 		else | ||||
| 		{ | ||||
| 			return Endpoint_BytesInEndpoint(); | ||||
| 		} | ||||
| 	} | ||||
| 	else | ||||
| 	{ | ||||
| 		return 0; | ||||
| 	} | ||||
| } | ||||
| 
 | ||||
| int16_t PRNT_Device_ReceiveByte(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| { | ||||
| 	if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
| 	  return -1; | ||||
| 
 | ||||
| 	int16_t ReceivedByte = -1; | ||||
| 
 | ||||
| 	Endpoint_SelectEndpoint(PRNTInterfaceInfo->Config.DataOUTEndpoint.Address); | ||||
| 
 | ||||
| 	if (Endpoint_IsOUTReceived()) | ||||
| 	{ | ||||
| 		if (Endpoint_BytesInEndpoint()) | ||||
| 		  ReceivedByte = Endpoint_Read_8(); | ||||
| 
 | ||||
| 		if (!(Endpoint_BytesInEndpoint())) | ||||
| 		  Endpoint_ClearOUT(); | ||||
| 	} | ||||
| 
 | ||||
| 	return ReceivedByte; | ||||
| } | ||||
| 
 | ||||
| #if defined(FDEV_SETUP_STREAM) | ||||
| void PRNT_Device_CreateStream(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
|                               FILE* const Stream) | ||||
| { | ||||
| 	*Stream = (FILE)FDEV_SETUP_STREAM(PRNT_Device_putchar, PRNT_Device_getchar, _FDEV_SETUP_RW); | ||||
| 	fdev_set_udata(Stream, PRNTInterfaceInfo); | ||||
| } | ||||
| 
 | ||||
| void PRNT_Device_CreateBlockingStream(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
|                                       FILE* const Stream) | ||||
| { | ||||
| 	*Stream = (FILE)FDEV_SETUP_STREAM(PRNT_Device_putchar, PRNT_Device_getchar_Blocking, _FDEV_SETUP_RW); | ||||
| 	fdev_set_udata(Stream, PRNTInterfaceInfo); | ||||
| } | ||||
| 
 | ||||
| static int PRNT_Device_putchar(char c, | ||||
|                                FILE* Stream) | ||||
| { | ||||
| 	return PRNT_Device_SendByte((USB_ClassInfo_PRNT_Device_t*)fdev_get_udata(Stream), c) ? _FDEV_ERR : 0; | ||||
| } | ||||
| 
 | ||||
| static int PRNT_Device_getchar(FILE* Stream) | ||||
| { | ||||
| 	int16_t ReceivedByte = PRNT_Device_ReceiveByte((USB_ClassInfo_PRNT_Device_t*)fdev_get_udata(Stream)); | ||||
| 
 | ||||
| 	if (ReceivedByte < 0) | ||||
| 	  return _FDEV_EOF; | ||||
| 
 | ||||
| 	return ReceivedByte; | ||||
| } | ||||
| 
 | ||||
| static int PRNT_Device_getchar_Blocking(FILE* Stream) | ||||
| { | ||||
| 	int16_t ReceivedByte; | ||||
| 
 | ||||
| 	while ((ReceivedByte = PRNT_Device_ReceiveByte((USB_ClassInfo_PRNT_Device_t*)fdev_get_udata(Stream))) < 0) | ||||
| 	{ | ||||
| 		if (USB_DeviceState == DEVICE_STATE_Unattached) | ||||
| 		  return _FDEV_EOF; | ||||
| 
 | ||||
| 		PRNT_Device_USBTask((USB_ClassInfo_PRNT_Device_t*)fdev_get_udata(Stream)); | ||||
| 		USB_USBTask(); | ||||
| 	} | ||||
| 
 | ||||
| 	return ReceivedByte; | ||||
| } | ||||
| #endif | ||||
| 
 | ||||
| void PRNT_Device_Event_Stub(void) | ||||
| { | ||||
| 
 | ||||
| } | ||||
| 
 | ||||
| #endif | ||||
| 
 | ||||
							
								
								
									
										279
									
								
								LUFA/Drivers/USB/Class/Device/PrinterClassDevice.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										279
									
								
								LUFA/Drivers/USB/Class/Device/PrinterClassDevice.h
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,279 @@ | |||
| /*
 | ||||
|              LUFA Library | ||||
|      Copyright (C) Dean Camera, 2013. | ||||
| 
 | ||||
|   dean [at] fourwalledcubicle [dot] com | ||||
|            www.lufa-lib.org | ||||
| */ | ||||
| 
 | ||||
| /*
 | ||||
|   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com) | ||||
| 
 | ||||
|   Permission to use, copy, modify, distribute, and sell this | ||||
|   software and its documentation for any purpose is hereby granted | ||||
|   without fee, provided that the above copyright notice appear in | ||||
|   all copies and that both that the copyright notice and this | ||||
|   permission notice and warranty disclaimer appear in supporting | ||||
|   documentation, and that the name of the author not be used in | ||||
|   advertising or publicity pertaining to distribution of the | ||||
|   software without specific, written prior permission. | ||||
| 
 | ||||
|   The author disclaims all warranties with regard to this | ||||
|   software, including all implied warranties of merchantability | ||||
|   and fitness.  In no event shall the author be liable for any | ||||
|   special, indirect or consequential damages or any damages | ||||
|   whatsoever resulting from loss of use, data or profits, whether | ||||
|   in an action of contract, negligence or other tortious action, | ||||
|   arising out of or in connection with the use or performance of | ||||
|   this software. | ||||
| */ | ||||
| 
 | ||||
| /** \file
 | ||||
|  *  \brief Device mode driver for the library USB Printer Class driver. | ||||
|  * | ||||
|  *  Device mode driver for the library USB Printer Class driver. | ||||
|  * | ||||
|  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver | ||||
|  *        dispatch header located in LUFA/Drivers/USB.h. | ||||
|  */ | ||||
| 
 | ||||
| /** \ingroup Group_USBClassPrinter
 | ||||
|  *  \defgroup Group_USBClassPrinterDevice Printer Class Device Mode Driver | ||||
|  * | ||||
|  *  \section Sec_Dependencies Module Source Dependencies | ||||
|  *  The following files must be built with any user project that uses this module: | ||||
|  *    - LUFA/Drivers/USB/Class/Device/PrinterClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> | ||||
|  * | ||||
|  *  \section Sec_ModDescription Module Description | ||||
|  *  Device Mode USB Class driver framework interface, for the Printer USB Class driver. | ||||
|  * | ||||
|  *  @{ | ||||
|  */ | ||||
| 
 | ||||
| #ifndef _PRINTER_CLASS_DEVICE_H_ | ||||
| #define _PRINTER_CLASS_DEVICE_H_ | ||||
| 
 | ||||
| 	/* Includes: */ | ||||
| 		#include "../../USB.h" | ||||
| 		#include "../Common/PrinterClassCommon.h" | ||||
| 
 | ||||
| 		#include <stdio.h> | ||||
| 
 | ||||
| 	/* Enable C linkage for C++ Compilers: */ | ||||
| 		#if defined(__cplusplus) | ||||
| 			extern "C" { | ||||
| 		#endif | ||||
| 
 | ||||
| 	/* Preprocessor Checks: */ | ||||
| 		#if !defined(__INCLUDE_FROM_PRINTER_DRIVER) | ||||
| 			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead. | ||||
| 		#endif | ||||
| 
 | ||||
| 	/* Public Interface - May be used in end-application: */ | ||||
| 		/* Type Defines: */ | ||||
| 			/** \brief Printer Class Device Mode Configuration and State Structure.
 | ||||
| 			 * | ||||
| 			 *  Class state structure. An instance of this structure should be made for each Printer interface | ||||
| 			 *  within the user application, and passed to each of the Printer class driver functions as the | ||||
| 			 *  PRNTInterfaceInfo parameter. This stores each Printer interface's configuration and state information. | ||||
| 			 */ | ||||
| 			typedef struct | ||||
| 			{ | ||||
| 				struct | ||||
| 				{ | ||||
| 					uint8_t InterfaceNumber; /**< Interface number of the Printer interface within the device. */ | ||||
| 
 | ||||
| 					USB_Endpoint_Table_t DataINEndpoint; /**< Data IN endpoint configuration table. */ | ||||
| 					USB_Endpoint_Table_t DataOUTEndpoint; /**< Data OUT endpoint configuration table. */ | ||||
| 
 | ||||
| 					char* IEEE1284String; /**< IEEE 1284 identification string, sent to the host during enumeration
 | ||||
| 					                       *   to identify the printer model, manufacturer and other characteristics. */ | ||||
| 				} 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. | ||||
| 				           */ | ||||
| 				struct | ||||
| 				{ | ||||
| 					uint8_t PortStatus; /**< Current status of the Printer virtual port, a collection of \c PRNT_PORTSTATUS_*
 | ||||
| 					                     *   bitmask values. */ | ||||
| 				} State; /**< State data for the USB class interface within the device. All elements in this section
 | ||||
| 				          *   are reset to their defaults when the interface is enumerated. | ||||
| 				          */ | ||||
| 			} USB_ClassInfo_PRNT_Device_t; | ||||
| 
 | ||||
| 		/* Function Prototypes: */ | ||||
| 			/** Configures the endpoints of a given Printer interface, ready for use. This should be linked to the library
 | ||||
| 			 *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing | ||||
| 			 *  the given Printer interface is selected. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 * | ||||
| 			 *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. | ||||
| 			 */ | ||||
| 			bool PRNT_Device_ConfigureEndpoints(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			/** Processes incoming control requests from the host, that are directed to the given Printer class interface. This should be
 | ||||
| 			 *  linked to the library \ref EVENT_USB_Device_ControlRequest() event. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 */ | ||||
| 			void PRNT_Device_ProcessControlRequest(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			/** General management task for a given Printer class interface, required for the correct operation of 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 configuration and state. | ||||
| 			 */ | ||||
| 			void PRNT_Device_USBTask(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			/** Sends a given data buffer to the attached USB host, if connected. If a host is not connected when the function is
 | ||||
| 			 *  called, the string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank | ||||
| 			 *  becomes full, or the \ref PRNT_Device_Flush() function is called to flush the pending data to the host. This allows | ||||
| 			 *  for multiple bytes to be packed into a single endpoint packet, increasing data throughput. | ||||
| 			 * | ||||
| 			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or | ||||
| 			 *       the call will fail. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device. | ||||
| 			 *  \param[in]     Length            Length of the data to send to the host. | ||||
| 			 * | ||||
| 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. | ||||
| 			 */ | ||||
| 			uint8_t PRNT_Device_SendData(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
| 			                             const void* const Buffer, | ||||
| 			                             const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); | ||||
| 
 | ||||
| 			/** Sends a given null terminated string to the attached USB host, if connected. If a host is not connected when
 | ||||
| 			 *  the function is called, the string is discarded. Bytes will be queued for transmission to the host until either | ||||
| 			 *  the endpoint bank becomes full, or the \ref PRNT_Device_Flush() function is called to flush the pending data to | ||||
| 			 *  the host. This allows for multiple bytes to be packed into a single endpoint packet, increasing data throughput. | ||||
| 			 * | ||||
| 			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or | ||||
| 			 *       the call will fail. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 *  \param[in]     String            Pointer to the null terminated string to send to the host. | ||||
| 			 * | ||||
| 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. | ||||
| 			 */ | ||||
| 			uint8_t PRNT_Device_SendString(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
| 			                               const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); | ||||
| 
 | ||||
| 			/** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
 | ||||
| 			 *  byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the | ||||
| 			 *  \ref PRNT_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be | ||||
| 			 *  packed into a single endpoint packet, increasing data throughput. | ||||
| 			 * | ||||
| 			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or | ||||
| 			 *       the call will fail. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 *  \param[in]     Data              Byte of data to send to the host. | ||||
| 			 * | ||||
| 			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum. | ||||
| 			 */ | ||||
| 			uint8_t PRNT_Device_SendByte(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
| 			                             const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			/** Determines the number of bytes received by the Printer interface from the host, waiting to be read. This indicates the number
 | ||||
| 			 *  of bytes in the OUT endpoint bank only, and thus the number of calls to \ref PRNT_Device_ReceiveByte() which are guaranteed to | ||||
| 			 *  succeed immediately. If multiple bytes are to be received, they should be buffered by the user application, as the endpoint | ||||
| 			 *  bank will not be released back to the USB controller until all bytes are read. | ||||
| 			 * | ||||
| 			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or | ||||
| 			 *       the call will fail. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 * | ||||
| 			 *  \return Total number of buffered bytes received from the host. | ||||
| 			 */ | ||||
| 			uint16_t PRNT_Device_BytesReceived(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			/** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function
 | ||||
| 			 *  returns a negative value. The \ref PRNT_Device_BytesReceived() function may be queried in advance to determine how many | ||||
| 			 *  bytes are currently buffered in the Printer interface's data receive endpoint bank, and thus how many repeated calls to this | ||||
| 			 *  function which are guaranteed to succeed. | ||||
| 			 * | ||||
| 			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or | ||||
| 			 *       the call will fail. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 * | ||||
| 			 *  \return Next received byte from the host, or a negative value if no data received. | ||||
| 			 */ | ||||
| 			int16_t PRNT_Device_ReceiveByte(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			/** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 | ||||
| 			 * | ||||
| 			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or | ||||
| 			 *       the call will fail. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 * | ||||
| 			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum. | ||||
| 			 */ | ||||
| 			uint8_t PRNT_Device_Flush(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 
 | ||||
| 			#if defined(FDEV_SETUP_STREAM) || defined(__DOXYGEN__) | ||||
| 			/** Creates a standard character stream for the given Printer Device instance so that it can be used with all the regular
 | ||||
| 			 *  functions in the standard <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf()). The created | ||||
| 			 *  stream is bidirectional and can be used for both input and output functions. | ||||
| 			 * | ||||
| 			 *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single | ||||
| 			 *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may | ||||
| 			 *  be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own | ||||
| 			 *  line buffering. | ||||
| 			 * | ||||
| 			 *  \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions | ||||
| 			 *        to the given Printer interface. | ||||
| 			 *        \n\n | ||||
| 			 * | ||||
| 			 *  \note This function is not available on all microcontroller architectures. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed. | ||||
| 			 */ | ||||
| 			void PRNT_Device_CreateStream(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
| 			                              FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); | ||||
| 
 | ||||
| 			/** Identical to \ref PRNT_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
 | ||||
| 			 *  the transfer. While blocking, the USB and Printer service tasks are called repeatedly to maintain USB communications. | ||||
| 			 * | ||||
| 			 *  \note This function is not available on all microcontroller architectures. | ||||
| 			 * | ||||
| 			 *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class configuration and state. | ||||
| 			 *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed. | ||||
| 			 */ | ||||
| 			void PRNT_Device_CreateBlockingStream(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo, | ||||
| 			                                      FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); | ||||
| 			#endif | ||||
| 
 | ||||
| 	/* Private Interface - For use in library only: */ | ||||
| 	#if !defined(__DOXYGEN__) | ||||
| 		/* Function Prototypes: */ | ||||
| 			#if defined(__INCLUDE_FROM_PRINTER_DEVICE_C) | ||||
| 				#if defined(FDEV_SETUP_STREAM) | ||||
| 				static int PRNT_Device_putchar(char c, | ||||
| 				                               FILE* Stream) ATTR_NON_NULL_PTR_ARG(2); | ||||
| 				static int PRNT_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 				static int PRNT_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); | ||||
| 				#endif | ||||
| 
 | ||||
| 				void PRNT_Device_Event_Stub(void) ATTR_CONST; | ||||
| 
 | ||||
| 				void EVENT_PRNT_Device_SoftReset(USB_ClassInfo_PRNT_Device_t* const PRNTInterfaceInfo) | ||||
| 				                                 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(PRNT_Device_Event_Stub); | ||||
| 
 | ||||
| 			#endif | ||||
| 
 | ||||
| 	#endif | ||||
| 
 | ||||
| 	/* Disable C linkage for C++ Compilers: */ | ||||
| 		#if defined(__cplusplus) | ||||
| 			} | ||||
| 		#endif | ||||
| 
 | ||||
| #endif | ||||
| 
 | ||||
| /** @} */ | ||||
| 
 | ||||
|  | @ -43,6 +43,7 @@ | |||
|  * | ||||
|  *  \section Sec_Dependencies Module Source Dependencies | ||||
|  *  The following files must be built with any user project that uses this module: | ||||
|  *    - LUFA/Drivers/USB/Class/Host/PrinterClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> | ||||
|  *    - LUFA/Drivers/USB/Class/Host/PrinterClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> | ||||
|  * | ||||
|  *  \section Sec_ModDescription Module Description | ||||
|  | @ -68,6 +69,10 @@ | |||
| 	/* Includes: */ | ||||
| 		#include "../Core/USBMode.h" | ||||
| 
 | ||||
| 		#if defined(USB_CAN_BE_DEVICE) | ||||
| 			#include "Device/PrinterClassDevice.h" | ||||
| 		#endif | ||||
| 
 | ||||
| 		#if defined(USB_CAN_BE_HOST) | ||||
| 			#include "Host/PrinterClassHost.h" | ||||
| 		#endif | ||||
|  |  | |||
|  | @ -127,8 +127,8 @@ | |||
|  *  </tr> | ||||
|  *  <tr> | ||||
|  *   <td>Printer</td> | ||||
|  *   <td bgcolor="#EE0000">No</td> | ||||
| *    <td bgcolor="#00EE00">Yes</td> | ||||
|  *   <td bgcolor="#00EE00">Yes</td> | ||||
|  *   <td bgcolor="#00EE00">Yes</td> | ||||
|  *  </tr> | ||||
|  *  <tr> | ||||
|  *   <td>RNDIS</td> | ||||
|  | @ -193,7 +193,7 @@ | |||
|  *  void EVENT_USB_Device_ConfigurationChanged(void) | ||||
|  *  { | ||||
|  *      LEDs_SetAllLEDs(LEDMASK_USB_READY); | ||||
|  *       | ||||
|  * | ||||
|  *      if (!(Audio_Device_ConfigureEndpoints(&My_Audio_Interface))) | ||||
|  *          LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||||
|  *  } | ||||
|  | @ -209,14 +209,14 @@ | |||
|  *  int main(void) | ||||
|  *  { | ||||
|  *      SetupHardware(); | ||||
|  *       | ||||
|  * | ||||
|  *      LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); | ||||
|  *       | ||||
|  * | ||||
|  *      for (;;) | ||||
|  *      { | ||||
|  *          if (USB_DeviceState != DEVICE_STATE_Configured) | ||||
|  *            Create_And_Process_Samples(); | ||||
|  *           | ||||
|  * | ||||
|  *          Audio_Device_USBTask(&My_Audio_Interface); | ||||
|  *          USB_USBTask(); | ||||
|  *      } | ||||
|  | @ -297,30 +297,30 @@ | |||
|  *  void EVENT_USB_Host_DeviceEnumerationComplete(void) | ||||
|  *  { | ||||
|  *      LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); | ||||
|  *       | ||||
|  * | ||||
|  *      uint16_t ConfigDescriptorSize; | ||||
|  *      uint8_t  ConfigDescriptorData[512]; | ||||
|  *       | ||||
|  * | ||||
|  *      if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData, | ||||
|  *                                             sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful) | ||||
|  *      { | ||||
|  *          LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||||
|  *          return; | ||||
|  *      } | ||||
|  *       | ||||
|  * | ||||
|  *      if (MIDI_Host_ConfigurePipes(&Keyboard_MIDI_Interface, | ||||
|  *                                   ConfigDescriptorSize, ConfigDescriptorData) != MIDI_ENUMERROR_NoError) | ||||
|  *      { | ||||
|  *          LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||||
|  *          return; | ||||
|  *      } | ||||
|  *       | ||||
|  * | ||||
|  *      if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful) | ||||
|  *      { | ||||
|  *          LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||||
|  *          return; | ||||
|  *      } | ||||
|  *       | ||||
|  * | ||||
|  *      LEDs_SetAllLEDs(LEDMASK_USB_READY); | ||||
|  *  } | ||||
|  *  \endcode | ||||
|  | @ -333,7 +333,7 @@ | |||
|  *  the configuration will fail. | ||||
|  * | ||||
|  *  To complete the device enumeration after binding the host mode Class Drivers to the attached device, a call to | ||||
|  *  \c USB_Host_SetDeviceConfiguration() must be made. If the device configuration is not set within the  | ||||
|  *  \c USB_Host_SetDeviceConfiguration() must be made. If the device configuration is not set within the | ||||
|  *  \c EVENT_USB_Host_DeviceEnumerationComplete() event, the host still will assume the device enumeration has failed. | ||||
|  * | ||||
|  *  Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's | ||||
|  | @ -346,14 +346,14 @@ | |||
|  *  int main(void) | ||||
|  *  { | ||||
|  *      SetupHardware(); | ||||
|  *       | ||||
|  * | ||||
|  *      LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); | ||||
|  *       | ||||
|  * | ||||
|  *      for (;;) | ||||
|  *      { | ||||
|  *          if (USB_HostState != HOST_STATE_Configured) | ||||
|  *              Create_And_Process_Samples(); | ||||
|  *           | ||||
|  * | ||||
|  *          MIDI_Host_USBTask(&My_Audio_Interface); | ||||
|  *          USB_USBTask(); | ||||
|  *      } | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Dean Camera
						Dean Camera