/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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 disclaim 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
 *
 *  Header file for PrinterCommands.c.
 */
 
#ifndef _PRINTER_COMMANDS_H_
#define _PRINTER_COMMANDS_H_

	/* Includes: */
		#include <avr/io.h>
		#include <string.h>

		#include <LUFA/Drivers/USB/USB.h>

	/* Macros: */
		/** Printer class-specific request to retrieve the printer's ID string */
		#define GET_DEVICE_ID                0

		/** Printer class-specific request to retrieve the printer's virtual port status flags */
		#define GET_PORT_STATUS              1

		/** Printer class-specific request to soft-reset the device */
		#define SOFT_RESET                   2

		/** Pipe number of the Printer data IN pipe */
		#define PRINTER_DATA_IN_PIPE         1

		/** Pipe number of the Printer data OUT pipe */
		#define PRINTER_DATA_OUT_PIPE        2
		
	/* Type Defines: */
		/** Type define for a Printer Command Data structure, for the encapsulation of raw printer commands to
		 *  send to an attached printer device.
		 */
		typedef struct
		{
			char*    Data; /**< Printer commands to send to the attached printer */
			uint16_t Length; /**< Length in bytes of the commands to send to the attached printer */
		} Printer_Data_t;
		
	/* Function Prototypes: */
		uint8_t Printer_SendData(Printer_Data_t* PrinterCommands);
		uint8_t Printer_GetDeviceID(char* DeviceIDString, uint16_t BufferSize);
		uint8_t Printer_GetPortStatus(uint8_t* PortStatus);
		uint8_t Printer_SoftReset(void);
	
#endif
