Minor documentation improvements.

[pub/USBasp.git] / Bootloaders / Printer / BootloaderPrinter.c

diff --git a/Bootloaders/Printer/BootloaderPrinter.c b/Bootloaders/Printer/BootloaderPrinter.c
index a913b33..a19cb06 100644 (file)
--- a/Bootloaders/Printer/BootloaderPrinter.c
+++ b/Bootloaders/Printer/BootloaderPrinter.c
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2013.
+     Copyright (C) Dean Camera, 2014.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -35,6 +35,35 @@
 
 #include "BootloaderPrinter.h"
 
 
 #include "BootloaderPrinter.h"
 

+/** LUFA Printer Class driver interface configuration and state information. This structure is
+ *  passed to all Printer Class driver functions, so that multiple instances of the same class
+ *  within a device can be differentiated from one another.
+ */
+USB_ClassInfo_PRNT_Device_t TextOnly_Printer_Interface =
+       {
+               .Config =
+                       {
+                               .InterfaceNumber          = INTERFACE_ID_Printer,
+                               .DataINEndpoint           =
+                                       {
+                                               .Address          = PRINTER_IN_EPADDR,
+                                               .Size             = PRINTER_IO_EPSIZE,
+                                               .Banks            = 1,
+                                       },
+                               .DataOUTEndpoint =
+                                       {
+                                               .Address          = PRINTER_OUT_EPADDR,
+                                               .Size             = PRINTER_IO_EPSIZE,
+                                               .Banks            = 1,
+                                       },
+                               .IEEE1284String =
+                                       "MFG:Generic;"
+                                       "MDL:Generic_/_Text_Only;"
+                                       "CMD:1284.4;"
+                                       "CLS:PRINTER",
+                       },
+       };
+

 /** Intel HEX parser state machine state information, to track the contents of
  *  a HEX file streamed in as a sequence of arbitrary bytes.
  */
 /** Intel HEX parser state machine state information, to track the contents of
  *  a HEX file streamed in as a sequence of arbitrary bytes.
  */


@@ -59,31 +88,45 @@ struct
        uint8_t  Checksum;
        /** Starting address of the last addressed FLASH page. */
        uint32_t PageStartAddress;
        uint8_t  Checksum;
        /** Starting address of the last addressed FLASH page. */
        uint32_t PageStartAddress;

+       /** Current 32-bit byte extended base address in FLASH being targeted. */
+       uint32_t CurrBaseAddress;

        /** Current 32-bit byte address in FLASH being targeted. */
        uint32_t CurrAddress;
        /** Current 32-bit byte address in FLASH being targeted. */
        uint32_t CurrAddress;

-} HEXParser =
-       {
-               .ParserState = HEX_PARSE_STATE_WAIT_LINE
-       };
+} HEXParser;

 
 /** Indicates if there is data waiting to be written to a physical page of
  *  memory in FLASH.
  */
 static bool PageDirty = false;
 
 
 /** Indicates if there is data waiting to be written to a physical page of
  *  memory in FLASH.
  */
 static bool PageDirty = false;
 

-/**
- * Determines if a given input byte of data is an ASCII encoded HEX value.
- *
- * \note Input HEX bytes are expected to be in uppercase only.
- *
- * \param[in] Byte  ASCII byte of data to check
- *
- * \return Boolean \c true if the input data is ASCII encoded HEX, false otherwise.
+/** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
+ *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
+ *  started via a forced watchdog reset.
+ */
+static bool RunBootloader = true;
+
+/** Magic lock for forced application start. If the HWBE fuse is programmed and BOOTRST is unprogrammed, the bootloader
+ *  will start if the /HWB line of the AVR is held low and the system is reset. However, if the /HWB line is still held
+ *  low when the application attempts to start via a watchdog reset, the bootloader will re-start. If set to the value
+ *  \ref MAGIC_BOOT_KEY the special init function \ref Application_Jump_Check() will force the application to start.
+ */
+uint16_t MagicBootKey ATTR_NO_INIT;
+
+
+/** Special startup routine to check if the bootloader was started via a watchdog reset, and if the magic application
+ *  start key has been loaded into \ref MagicBootKey. If the bootloader started via the watchdog and the key is valid,
+ *  this will force the user application to start via a software jump.

  */
  */

-static bool IsHex(const char Byte)
+void Application_Jump_Check(void)

 {
 {

-       return ((Byte >= 'A') && (Byte <= 'F')) ||
-              ((Byte >= '0') && (Byte <= '9'));
+       /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
+       if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
+       {
+               MagicBootKey = 0;
+
+               // cppcheck-suppress constStatement
+               ((void (*)(void))0x0000)();
+       }

 }
 
 /**
 }
 
 /**


@@ -93,16 +136,42 @@ static bool IsHex(const char Byte)
  *
  * \param[in] Byte  ASCII byte of data to convert
  *
  *
  * \param[in] Byte  ASCII byte of data to convert
  *

- * \return Integer converted value of the input ASCII encoded HEX byte of data.
+ * \return Integer converted value of the input ASCII encoded HEX byte of data, or -1 if the
+ *         input is not valid ASCII encoded HEX.

  */
  */

-static uint8_t HexToDecimal(const char Byte)
+static int8_t HexToDecimal(const char Byte)

 {
        if ((Byte >= 'A') && (Byte <= 'F'))
          return (10 + (Byte - 'A'));
        else if ((Byte >= '0') && (Byte <= '9'))
          return (Byte - '0');
 
 {
        if ((Byte >= 'A') && (Byte <= 'F'))
          return (10 + (Byte - 'A'));
        else if ((Byte >= '0') && (Byte <= '9'))
          return (Byte - '0');
 

-       return 0;
+       return -1;
+}
+
+/**
+ * Flushes a partially written page of data to physical FLASH, if a page
+ * boundary has been crossed.
+ *
+ * \note If a page flush occurs the global HEX parser state is updated.
+ */
+static void FlushPageIfRequired(void)
+{
+       /* Abort if no data has been buffered for writing to the current page */
+       if (!PageDirty)
+         return;
+
+       /* Flush the FLASH page to physical memory if we are crossing a page boundary */
+       uint32_t NewPageStartAddress = (HEXParser.CurrAddress & ~(SPM_PAGESIZE - 1));
+       if (HEXParser.PageStartAddress != NewPageStartAddress)
+       {
+               boot_page_write(HEXParser.PageStartAddress);
+               boot_spm_busy_wait();
+
+               HEXParser.PageStartAddress = NewPageStartAddress;
+
+               PageDirty = false;
+       }

 }
 
 /**
 }
 
 /**


@@ -113,28 +182,36 @@ static uint8_t HexToDecimal(const char Byte)
  */
 static void ParseIntelHEXByte(const char ReadCharacter)
 {
  */
 static void ParseIntelHEXByte(const char ReadCharacter)
 {

+       /* Reset the line parser while waiting for a new line to start */

        if ((HEXParser.ParserState == HEX_PARSE_STATE_WAIT_LINE) || (ReadCharacter == ':'))
        {
                HEXParser.Checksum     = 0;
        if ((HEXParser.ParserState == HEX_PARSE_STATE_WAIT_LINE) || (ReadCharacter == ':'))
        {
                HEXParser.Checksum     = 0;

-               HEXParser.CurrAddress &= ~0xFFFF;
-               HEXParser.ParserState  = HEX_PARSE_STATE_WAIT_LINE;
+               HEXParser.CurrAddress  = HEXParser.CurrBaseAddress;

                HEXParser.ReadMSB      = false;
 
                HEXParser.ReadMSB      = false;
 

+               /* ASCII ':' indicates the start of a new HEX record */

                if (ReadCharacter == ':')
                  HEXParser.ParserState = HEX_PARSE_STATE_BYTE_COUNT;
 
                return;
        }
 
                if (ReadCharacter == ':')
                  HEXParser.ParserState = HEX_PARSE_STATE_BYTE_COUNT;
 
                return;
        }
 

-       if (!IsHex(ReadCharacter))
+       /* Only allow ASCII HEX encoded digits, ignore all other characters */
+       int8_t ReadCharacterDec = HexToDecimal(ReadCharacter);
+       if (ReadCharacterDec < 0)

          return;
 
          return;
 

-       HEXParser.Data    = (HEXParser.Data << 4) | HexToDecimal(ReadCharacter);
+       /* Read and convert the next nibble of data from the current character */
+       HEXParser.Data    = (HEXParser.Data << 4) | ReadCharacterDec;

        HEXParser.ReadMSB = !HEXParser.ReadMSB;
 
        HEXParser.ReadMSB = !HEXParser.ReadMSB;
 

+       /* Only process further when a full byte (two nibbles) have been read */

        if (HEXParser.ReadMSB)
          return;
 
        if (HEXParser.ReadMSB)
          return;
 

+       /* Intel HEX checksum is for all fields except starting character and the
+        * checksum itself
+        */

        if (HEXParser.ParserState != HEX_PARSE_STATE_CHECKSUM)
          HEXParser.Checksum += HEXParser.Data;
 
        if (HEXParser.ParserState != HEX_PARSE_STATE_CHECKSUM)
          HEXParser.Checksum += HEXParser.Data;
 


@@ -146,12 +223,12 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                        break;
 
                case HEX_PARSE_STATE_ADDRESS_HIGH:
                        break;
 
                case HEX_PARSE_STATE_ADDRESS_HIGH:

-                       HEXParser.CurrAddress |= ((uint16_t)HEXParser.Data << 8);
+                       HEXParser.CurrAddress += ((uint16_t)HEXParser.Data << 8);

                        HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_LOW;
                        break;
 
                case HEX_PARSE_STATE_ADDRESS_LOW:
                        HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_LOW;
                        break;
 
                case HEX_PARSE_STATE_ADDRESS_LOW:

-                       HEXParser.CurrAddress |= HEXParser.Data;
+                       HEXParser.CurrAddress += HEXParser.Data;

                        HEXParser.ParserState  = HEX_PARSE_STATE_RECORD_TYPE;
                        break;
 
                        HEXParser.ParserState  = HEX_PARSE_STATE_RECORD_TYPE;
                        break;
 


@@ -161,17 +238,31 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                        break;
 
                case HEX_PARSE_STATE_READ_DATA:
                        break;
 
                case HEX_PARSE_STATE_READ_DATA:

+                       /* Track the number of read data bytes in the record */

                        HEXParser.DataRem--;
 
                        HEXParser.DataRem--;
 

+                       /* Protect the bootloader against being written to */
+                       if (HEXParser.CurrAddress >= BOOT_START_ADDR)
+                       {
+                               HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
+                               PageDirty = false;
+                               return;
+                       }
+
+                       /* Wait for a machine word (two bytes) of data to be read */

                        if (HEXParser.DataRem & 0x01)
                        {
                                HEXParser.PrevData = HEXParser.Data;
                                break;
                        }
 
                        if (HEXParser.DataRem & 0x01)
                        {
                                HEXParser.PrevData = HEXParser.Data;
                                break;
                        }
 

+                       /* Convert the last two received data bytes into a 16-bit word */
+                       uint16_t NewDataWord = ((uint16_t)HEXParser.Data << 8) | HEXParser.PrevData;
+

                        switch (HEXParser.RecordType)
                        {
                                case HEX_RECORD_TYPE_Data:
                        switch (HEXParser.RecordType)
                        {
                                case HEX_RECORD_TYPE_Data:

+                                       /* If we are writing to a new page, we need to erase it first */

                                        if (!(PageDirty))
                                        {
                                                boot_page_erase(HEXParser.PageStartAddress);
                                        if (!(PageDirty))
                                        {
                                                boot_page_erase(HEXParser.PageStartAddress);


@@ -180,23 +271,22 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                                                PageDirty = true;
                                        }
 
                                                PageDirty = true;
                                        }
 

-                                       boot_page_fill(HEXParser.CurrAddress, ((uint16_t)HEXParser.Data << 8) | HEXParser.PrevData);
+                                       /* Fill the FLASH memory buffer with the new word of data */
+                                       boot_page_fill(HEXParser.CurrAddress, NewDataWord);

                                        HEXParser.CurrAddress += 2;
 
                                        HEXParser.CurrAddress += 2;
 

-                                       uint32_t NewPageStartAddress = (HEXParser.CurrAddress & ~(SPM_PAGESIZE - 1));
-                                       if (PageDirty && (HEXParser.PageStartAddress != NewPageStartAddress))
-                                       {
-                                               boot_page_write(HEXParser.PageStartAddress);
-                                               boot_spm_busy_wait();
-
-                                               HEXParser.PageStartAddress = NewPageStartAddress;
+                                       /* Flush the FLASH page to physical memory if we are crossing a page boundary */
+                                       FlushPageIfRequired();
+                                       break;

 
 

-                                               PageDirty = false;
-                                       }
+                               case HEX_RECORD_TYPE_ExtendedSegmentAddress:
+                                       /* Extended address data - store the upper 12-bits of the new address */
+                                       HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 4);

                                        break;
 
                                case HEX_RECORD_TYPE_ExtendedLinearAddress:
                                        break;
 
                                case HEX_RECORD_TYPE_ExtendedLinearAddress:

-                                       HEXParser.CurrAddress |= (uint32_t)HEXParser.Data << (HEXParser.DataRem ? 24 : 16);
+                                       /* Extended address data - store the upper 16-bits of the new address */
+                                       HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 16);

                                        break;
                        }
 
                                        break;
                        }
 


@@ -205,19 +295,16 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                        break;
 
                case HEX_PARSE_STATE_CHECKSUM:
                        break;
 
                case HEX_PARSE_STATE_CHECKSUM:

+                       /* Verify checksum of the completed record */

                        if (HEXParser.Data != ((~HEXParser.Checksum + 1) & 0xFF))
                          break;
 
                        if (HEXParser.Data != ((~HEXParser.Checksum + 1) & 0xFF))
                          break;
 

-                       uint32_t NewPageStartAddress = (HEXParser.CurrAddress & ~(SPM_PAGESIZE - 1));
-                       if (PageDirty && (HEXParser.PageStartAddress != NewPageStartAddress))
-                       {
-                               boot_page_write(HEXParser.PageStartAddress);
-                               boot_spm_busy_wait();
+                       /* Flush the FLASH page to physical memory if we are crossing a page boundary */
+                       FlushPageIfRequired();

 
 

-                               HEXParser.PageStartAddress = NewPageStartAddress;
-
-                               PageDirty = false;
-                       }
+                       /* If end of the HEX file reached, the bootloader should exit at next opportunity */
+                       if (HEXParser.RecordType == HEX_RECORD_TYPE_EndOfFile)
+                         RunBootloader = false;

 
                        break;
 
 
                        break;
 


@@ -237,33 +324,43 @@ int main(void)
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        GlobalInterruptEnable();
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        GlobalInterruptEnable();
 

-       for (;;)
+       while (RunBootloader)

        {
        {

-               USB_USBTask();
-
-               Endpoint_SelectEndpoint(PRINTER_OUT_EPADDR);
+               uint8_t BytesReceived = PRNT_Device_BytesReceived(&TextOnly_Printer_Interface);

 
 

-               /* Check if we have received new printer data from the host */
-               if (Endpoint_IsOUTReceived()) {
-                       LEDs_ToggleLEDs(LEDMASK_USB_BUSY);
+               if (BytesReceived)
+               {
+                       LEDs_SetAllLEDs(LEDMASK_USB_BUSY);

 
 

-                       /* Read all bytes of data from the host and parse them */
-                       while (Endpoint_IsReadWriteAllowed())
+                       while (BytesReceived--)

                        {
                        {

+                               int16_t ReceivedByte = PRNT_Device_ReceiveByte(&TextOnly_Printer_Interface);
+

                                /* Feed the next byte of data to the HEX parser */
                                /* Feed the next byte of data to the HEX parser */

-                               ParseIntelHEXByte(Endpoint_Read_8());
+                               ParseIntelHEXByte(ReceivedByte);

                        }
 
                        }
 

-                       /* Send an ACK to the host, ready for the next data packet */
-                       Endpoint_ClearOUT();
-

                        LEDs_SetAllLEDs(LEDMASK_USB_READY);
                }
                        LEDs_SetAllLEDs(LEDMASK_USB_READY);
                }

+
+               PRNT_Device_USBTask(&TextOnly_Printer_Interface);
+               USB_USBTask();

        }
        }

+
+       /* Disconnect from the host - USB interface will be reset later along with the AVR */
+       USB_Detach();
+
+       /* Unlock the forced application start mode of the bootloader if it is restarted */
+       MagicBootKey = MAGIC_BOOT_KEY;
+
+       /* Enable the watchdog and force a timeout to reset the AVR */
+       wdt_enable(WDTO_250MS);
+
+       for (;;);

 }
 
 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 }
 
 /** Configures the board hardware and chip peripherals for the demo's functionality. */

-void SetupHardware(void)
+static void SetupHardware(void)

 {
        /* Disable watchdog if enabled by bootloader/fuses */
        MCUSR &= ~(1 << WDRF);
 {
        /* Disable watchdog if enabled by bootloader/fuses */
        MCUSR &= ~(1 << WDRF);


@@ -279,6 +376,16 @@ void SetupHardware(void)
        /* Hardware Initialization */
        LEDs_Init();
        USB_Init();
        /* Hardware Initialization */
        LEDs_Init();
        USB_Init();

+
+       /* Bootloader active LED toggle timer initialization */
+       TIMSK1 = (1 << TOIE1);
+       TCCR1B = ((1 << CS11) | (1 << CS10));
+}
+
+/** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
+ISR(TIMER1_OVF_vect, ISR_BLOCK)
+{
+       LEDs_ToggleLEDs(LEDS_LED1 | LEDS_LED2);

 }
 
 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
 }
 
 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */


@@ -289,7 +396,7 @@ void EVENT_USB_Device_Connect(void)
 }
 
 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 }
 
 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via

- *  the status LEDs and stops the Mass Storage management task.
+ *  the status LEDs and stops the Printer management task.

  */
 void EVENT_USB_Device_Disconnect(void)
 {
  */
 void EVENT_USB_Device_Disconnect(void)
 {


@@ -305,8 +412,10 @@ void EVENT_USB_Device_ConfigurationChanged(void)
        bool ConfigSuccess = true;
 
        /* Setup Printer Data Endpoints */
        bool ConfigSuccess = true;
 
        /* Setup Printer Data Endpoints */

-       ConfigSuccess &= Endpoint_ConfigureEndpoint(PRINTER_IN_EPADDR,  EP_TYPE_BULK, PRINTER_IO_EPSIZE, 1);
-       ConfigSuccess &= Endpoint_ConfigureEndpoint(PRINTER_OUT_EPADDR, EP_TYPE_BULK, PRINTER_IO_EPSIZE, 1);
+       ConfigSuccess &= PRNT_Device_ConfigureEndpoints(&TextOnly_Printer_Interface);
+
+       /* Reset the HEX parser upon successful connection to a host */
+       HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;

 
        /* Indicate endpoint configuration success or failure */
        LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 
        /* Indicate endpoint configuration success or failure */
        LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);


@@ -318,44 +427,5 @@ void EVENT_USB_Device_ConfigurationChanged(void)
  */
 void EVENT_USB_Device_ControlRequest(void)
 {
  */
 void EVENT_USB_Device_ControlRequest(void)
 {

-       /* Process Printer specific control requests */
-       switch (USB_ControlRequest.bRequest)
-       {
-               case PRNT_REQ_GetDeviceID:
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
-                       {
-                               /* Generic printer IEEE 1284 identification string, will bind to an in-built driver on
-                                * Windows systems, and will fall-back to a text-only printer driver on *nix.
-                                */
-                               const char PrinterIDString[] =
-                                       "MFG:Generic;"
-                                       "MDL:Generic_/_Text_Only;"
-                                       "CMD:1284.4;"
-                                       "CLS:PRINTER";
-
-                               Endpoint_ClearSETUP();
-                               Endpoint_Write_16_BE(sizeof(PrinterIDString));
-                               Endpoint_Write_Control_Stream_LE(PrinterIDString, strlen(PrinterIDString));
-                               Endpoint_ClearStatusStage();
-                       }
-
-                       break;
-               case PRNT_REQ_GetPortStatus:
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
-                       {
-                               Endpoint_ClearSETUP();
-                               Endpoint_Write_8(PRNT_PORTSTATUS_NOTERROR | PRNT_PORTSTATUS_SELECT);
-                               Endpoint_ClearStatusStage();
-                       }
-
-                       break;
-               case PRNT_REQ_SoftReset:
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
-                       {
-                               Endpoint_ClearSETUP();
-                               Endpoint_ClearStatusStage();
-                       }
-
-                       break;
-       }
+       PRNT_Device_ProcessControlRequest(&TextOnly_Printer_Interface);

 }
 }