Minor documentation improvements.

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

diff --git a/Bootloaders/Printer/BootloaderPrinter.c b/Bootloaders/Printer/BootloaderPrinter.c
index 023ec3e..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


@@ -43,7 +43,7 @@ USB_ClassInfo_PRNT_Device_t TextOnly_Printer_Interface =
        {
                .Config =
                        {
        {
                .Config =
                        {

-                               .InterfaceNumber          = 0,
+                               .InterfaceNumber          = INTERFACE_ID_Printer,

                                .DataINEndpoint           =
                                        {
                                                .Address          = PRINTER_IN_EPADDR,
                                .DataINEndpoint           =
                                        {
                                                .Address          = PRINTER_IN_EPADDR,


@@ -92,17 +92,13 @@ struct
        uint32_t CurrBaseAddress;
        /** Current 32-bit byte address in FLASH being targeted. */
        uint32_t CurrAddress;
        uint32_t CurrBaseAddress;
        /** 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;
 

-

 /** 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.
 /** 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.


@@ -134,37 +130,48 @@ void Application_Jump_Check(void)
 }
 
 /**
 }
 
 /**

- * 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, \c false otherwise.
- */
-static bool IsHex(const char Byte)
-{
-       return ((Byte >= 'A') && (Byte <= 'F')) ||
-              ((Byte >= '0') && (Byte <= '9'));
-}
-
-/**

  * Converts a given input byte of data from an ASCII encoded HEX value to an integer value.
  *
  * \note Input HEX bytes are expected to be in uppercase only.
  *
  * \param[in] Byte  ASCII byte of data to convert
  *
  * Converts a given input byte of data from an ASCII encoded HEX value to an integer value.
  *
  * \note Input HEX bytes are expected to be in uppercase only.
  *
  * \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;
+       }

 }
 
 /**
 }
 
 /**


@@ -180,7 +187,6 @@ static void ParseIntelHEXByte(const char ReadCharacter)
        {
                HEXParser.Checksum     = 0;
                HEXParser.CurrAddress  = HEXParser.CurrBaseAddress;
        {
                HEXParser.Checksum     = 0;
                HEXParser.CurrAddress  = HEXParser.CurrBaseAddress;

-               HEXParser.ParserState  = HEX_PARSE_STATE_WAIT_LINE;

                HEXParser.ReadMSB      = false;
 
                /* ASCII ':' indicates the start of a new HEX record */
                HEXParser.ReadMSB      = false;
 
                /* ASCII ':' indicates the start of a new HEX record */


@@ -191,11 +197,12 @@ static void ParseIntelHEXByte(const char ReadCharacter)
        }
 
        /* Only allow ASCII HEX encoded digits, ignore all other characters */
        }
 
        /* Only allow ASCII HEX encoded digits, ignore all other characters */

-       if (!IsHex(ReadCharacter))
+       int8_t ReadCharacterDec = HexToDecimal(ReadCharacter);
+       if (ReadCharacterDec < 0)

          return;
 
        /* Read and convert the next nibble of data from the current character */
          return;
 
        /* Read and convert the next nibble of data from the current character */

-       HEXParser.Data    = (HEXParser.Data << 4) | HexToDecimal(ReadCharacter);
+       HEXParser.Data    = (HEXParser.Data << 4) | ReadCharacterDec;

        HEXParser.ReadMSB = !HEXParser.ReadMSB;
 
        /* Only process further when a full byte (two nibbles) have been read */
        HEXParser.ReadMSB = !HEXParser.ReadMSB;
 
        /* Only process further when a full byte (two nibbles) have been read */


@@ -255,9 +262,7 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                        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 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);


@@ -271,16 +276,7 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                                        HEXParser.CurrAddress += 2;
 
                                        /* Flush the FLASH page to physical memory if we are crossing a page boundary */
                                        HEXParser.CurrAddress += 2;
 
                                        /* Flush the FLASH page to physical memory if we are crossing a page boundary */

-                                       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;
-
-                                               PageDirty = false;
-                                       }
+                                       FlushPageIfRequired();

                                        break;
 
                                case HEX_RECORD_TYPE_ExtendedSegmentAddress:
                                        break;
 
                                case HEX_RECORD_TYPE_ExtendedSegmentAddress:


@@ -304,16 +300,7 @@ static void ParseIntelHEXByte(const char ReadCharacter)
                          break;
 
                        /* Flush the FLASH page to physical memory if we are crossing a page boundary */
                          break;
 
                        /* Flush the FLASH page to physical memory if we are crossing a page boundary */

-                       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;
-
-                               PageDirty = false;
-                       }
+                       FlushPageIfRequired();

 
                        /* If end of the HEX file reached, the bootloader should exit at next opportunity */
                        if (HEXParser.RecordType == HEX_RECORD_TYPE_EndOfFile)
 
                        /* If end of the HEX file reached, the bootloader should exit at next opportunity */
                        if (HEXParser.RecordType == HEX_RECORD_TYPE_EndOfFile)


@@ -427,6 +414,9 @@ void EVENT_USB_Device_ConfigurationChanged(void)
        /* Setup Printer Data Endpoints */
        ConfigSuccess &= PRNT_Device_ConfigureEndpoints(&TextOnly_Printer_Interface);
 
        /* Setup Printer Data Endpoints */
        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);
 }