Bootloaders/Printer/BootloaderPrinter.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the Printer class bootloader. This file contains the complete bootloader logic.
  34  */
  35
  36 #include "BootloaderPrinter.h"
  37
  38 /** LUFA Printer Class driver interface configuration and state information. This structure is
  39  *  passed to all Printer Class driver functions, so that multiple instances of the same class
  40  *  within a device can be differentiated from one another.
  41  */
  42 USB_ClassInfo_PRNT_Device_t TextOnly_Printer_Interface =
  43         {
  44                 .Config =
  45                         {
  46                                 .InterfaceNumber          = 0,
  47                                 .DataINEndpoint           =
  48                                         {
  49                                                 .Address          = PRINTER_IN_EPADDR,
  50                                                 .Size             = PRINTER_IO_EPSIZE,
  51                                                 .Banks            = 1,
  52                                         },
  53                                 .DataOUTEndpoint =
  54                                         {
  55                                                 .Address          = PRINTER_OUT_EPADDR,
  56                                                 .Size             = PRINTER_IO_EPSIZE,
  57                                                 .Banks            = 1,
  58                                         },
  59                                 .IEEE1284String =
  60                                         "MFG:Generic;"
  61                                         "MDL:Generic_/_Text_Only;"
  62                                         "CMD:1284.4;"
  63                                         "CLS:PRINTER",
  64                         },
  65         };
  66
  67 /** Intel HEX parser state machine state information, to track the contents of
  68  *  a HEX file streamed in as a sequence of arbitrary bytes.
  69  */
  70 struct
  71 {
  72         /** Current HEX parser state machine state. */
  73         uint8_t  ParserState;
  74         /** Previously decoded numerical byte of data. */
  75         uint8_t  PrevData;
  76         /** Currently decoded numerical byte of data. */
  77         uint8_t  Data;
  78         /** Indicates if both bytes that correspond to a single decoded numerical
  79          *  byte of data (HEX encodes values in ASCII HEX, two characters per byte)
  80          *  have been read.
  81          */
  82         bool     ReadMSB;
  83         /** Intel HEX record type of the current Intel HEX record. */
  84         uint8_t  RecordType;
  85         /** Numerical bytes of data remaining to be read in the current record. */
  86         uint8_t  DataRem;
  87         /** Checksum of the current record received so far. */
  88         uint8_t  Checksum;
  89         /** Starting address of the last addressed FLASH page. */
  90         uint32_t PageStartAddress;
  91         /** Current 32-bit byte extended base address in FLASH being targeted. */
  92         uint32_t CurrBaseAddress;
  93         /** Current 32-bit byte address in FLASH being targeted. */
  94         uint32_t CurrAddress;
  95 } HEXParser =
  96         {
  97                 .ParserState = HEX_PARSE_STATE_WAIT_LINE
  98         };
  99
 100 /** Indicates if there is data waiting to be written to a physical page of
 101  *  memory in FLASH.
 102  */
 103 static bool PageDirty = false;
 104
 105
 106 /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
 107  *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
 108  *  started via a forced watchdog reset.
 109  */
 110 static bool RunBootloader = true;
 111
 112 /** Magic lock for forced application start. If the HWBE fuse is programmed and BOOTRST is unprogrammed, the bootloader
 113  *  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
 114  *  low when the application attempts to start via a watchdog reset, the bootloader will re-start. If set to the value
 115  *  \ref MAGIC_BOOT_KEY the special init function \ref Application_Jump_Check() will force the application to start.
 116  */
 117 uint16_t MagicBootKey ATTR_NO_INIT;
 118
 119
 120 /** Special startup routine to check if the bootloader was started via a watchdog reset, and if the magic application
 121  *  start key has been loaded into \ref MagicBootKey. If the bootloader started via the watchdog and the key is valid,
 122  *  this will force the user application to start via a software jump.
 123  */
 124 void Application_Jump_Check(void)
 125 {
 126         /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
 127         if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
 128         {
 129                 MagicBootKey = 0;
 130
 131                 // cppcheck-suppress constStatement
 132                 ((void (*)(void))0x0000)();
 133         }
 134 }
 135
 136 /**
 137  * Converts a given input byte of data from an ASCII encoded HEX value to an integer value.
 138  *
 139  * \note Input HEX bytes are expected to be in uppercase only.
 140  *
 141  * \param[in] Byte  ASCII byte of data to convert
 142  *
 143  * \return Integer converted value of the input ASCII encoded HEX byte of data, or -1 if the
 144  *         input is not valid ASCII encoded HEX.
 145  */
 146 static int8_t HexToDecimal(const char Byte)
 147 {
 148         if ((Byte >= 'A') && (Byte <= 'F'))
 149           return (10 + (Byte - 'A'));
 150         else if ((Byte >= '0') && (Byte <= '9'))
 151           return (Byte - '0');
 152
 153         return -1;
 154 }
 155
 156 /**
 157  * Parses an input Intel HEX formatted stream one character at a time, loading
 158  * the data contents into the device's internal FLASH memory.
 159  *
 160  * \param[in] ReadCharacter  Next input ASCII byte of data to parse
 161  */
 162 static void ParseIntelHEXByte(const char ReadCharacter)
 163 {
 164         /* Reset the line parser while waiting for a new line to start */
 165         if ((HEXParser.ParserState == HEX_PARSE_STATE_WAIT_LINE) || (ReadCharacter == ':'))
 166         {
 167                 HEXParser.Checksum     = 0;
 168                 HEXParser.CurrAddress  = HEXParser.CurrBaseAddress;
 169                 HEXParser.ReadMSB      = false;
 170
 171                 /* ASCII ':' indicates the start of a new HEX record */
 172                 if (ReadCharacter == ':')
 173                   HEXParser.ParserState = HEX_PARSE_STATE_BYTE_COUNT;
 174
 175                 return;
 176         }
 177
 178         /* Only allow ASCII HEX encoded digits, ignore all other characters */
 179         int8_t ReadCharacterDec = HexToDecimal(ReadCharacter);
 180         if (ReadCharacterDec < 0)
 181           return;
 182
 183         /* Read and convert the next nibble of data from the current character */
 184         HEXParser.Data    = (HEXParser.Data << 4) | ReadCharacterDec;
 185         HEXParser.ReadMSB = !HEXParser.ReadMSB;
 186
 187         /* Only process further when a full byte (two nibbles) have been read */
 188         if (HEXParser.ReadMSB)
 189           return;
 190
 191         /* Intel HEX checksum is for all fields except starting character and the
 192          * checksum itself
 193          */
 194         if (HEXParser.ParserState != HEX_PARSE_STATE_CHECKSUM)
 195           HEXParser.Checksum += HEXParser.Data;
 196
 197         switch (HEXParser.ParserState)
 198         {
 199                 case HEX_PARSE_STATE_BYTE_COUNT:
 200                         HEXParser.DataRem      = HEXParser.Data;
 201                         HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_HIGH;
 202                         break;
 203
 204                 case HEX_PARSE_STATE_ADDRESS_HIGH:
 205                         HEXParser.CurrAddress += ((uint16_t)HEXParser.Data << 8);
 206                         HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_LOW;
 207                         break;
 208
 209                 case HEX_PARSE_STATE_ADDRESS_LOW:
 210                         HEXParser.CurrAddress += HEXParser.Data;
 211                         HEXParser.ParserState  = HEX_PARSE_STATE_RECORD_TYPE;
 212                         break;
 213
 214                 case HEX_PARSE_STATE_RECORD_TYPE:
 215                         HEXParser.RecordType   = HEXParser.Data;
 216                         HEXParser.ParserState  = (HEXParser.DataRem ? HEX_PARSE_STATE_READ_DATA : HEX_PARSE_STATE_CHECKSUM);
 217                         break;
 218
 219                 case HEX_PARSE_STATE_READ_DATA:
 220                         /* Track the number of read data bytes in the record */
 221                         HEXParser.DataRem--;
 222
 223                         /* Protect the bootloader against being written to */
 224                         if (HEXParser.CurrAddress >= BOOT_START_ADDR)
 225                         {
 226                                 HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
 227                                 PageDirty = false;
 228                                 return;
 229                         }
 230
 231                         /* Wait for a machine word (two bytes) of data to be read */
 232                         if (HEXParser.DataRem & 0x01)
 233                         {
 234                                 HEXParser.PrevData = HEXParser.Data;
 235                                 break;
 236                         }
 237
 238                         /* Convert the last two received data bytes into a 16-bit word */
 239                         uint16_t NewDataWord = ((uint16_t)HEXParser.Data << 8) | HEXParser.PrevData;
 240
 241                         switch (HEXParser.RecordType)
 242                         {
 243                                 case HEX_RECORD_TYPE_Data:
 244                                         /* If we are writing to a new page, we need to erase it
 245                                          * first
 246                                          */
 247                                         if (!(PageDirty))
 248                                         {
 249                                                 boot_page_erase(HEXParser.PageStartAddress);
 250                                                 boot_spm_busy_wait();
 251
 252                                                 PageDirty = true;
 253                                         }
 254
 255                                         /* Fill the FLASH memory buffer with the new word of data */
 256                                         boot_page_fill(HEXParser.CurrAddress, NewDataWord);
 257                                         HEXParser.CurrAddress += 2;
 258
 259                                         /* Flush the FLASH page to physical memory if we are crossing a page boundary */
 260                                         uint32_t NewPageStartAddress = (HEXParser.CurrAddress & ~(SPM_PAGESIZE - 1));
 261                                         if (PageDirty && (HEXParser.PageStartAddress != NewPageStartAddress))
 262                                         {
 263                                                 boot_page_write(HEXParser.PageStartAddress);
 264                                                 boot_spm_busy_wait();
 265
 266                                                 HEXParser.PageStartAddress = NewPageStartAddress;
 267
 268                                                 PageDirty = false;
 269                                         }
 270                                         break;
 271
 272                                 case HEX_RECORD_TYPE_ExtendedSegmentAddress:
 273                                         /* Extended address data - store the upper 12-bits of the new address */
 274                                         HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 4);
 275                                         break;
 276
 277                                 case HEX_RECORD_TYPE_ExtendedLinearAddress:
 278                                         /* Extended address data - store the upper 16-bits of the new address */
 279                                         HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 16);
 280                                         break;
 281                         }
 282
 283                         if (!HEXParser.DataRem)
 284                           HEXParser.ParserState = HEX_PARSE_STATE_CHECKSUM;
 285                         break;
 286
 287                 case HEX_PARSE_STATE_CHECKSUM:
 288                         /* Verify checksum of the completed record */
 289                         if (HEXParser.Data != ((~HEXParser.Checksum + 1) & 0xFF))
 290                           break;
 291
 292                         /* Flush the FLASH page to physical memory if we are crossing a page boundary */
 293                         uint32_t NewPageStartAddress = (HEXParser.CurrAddress & ~(SPM_PAGESIZE - 1));
 294                         if (PageDirty && (HEXParser.PageStartAddress != NewPageStartAddress))
 295                         {
 296                                 boot_page_write(HEXParser.PageStartAddress);
 297                                 boot_spm_busy_wait();
 298
 299                                 HEXParser.PageStartAddress = NewPageStartAddress;
 300
 301                                 PageDirty = false;
 302                         }
 303
 304                         /* If end of the HEX file reached, the bootloader should exit at next opportunity */
 305                         if (HEXParser.RecordType == HEX_RECORD_TYPE_EndOfFile)
 306                           RunBootloader = false;
 307
 308                         break;
 309
 310                 default:
 311                         HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
 312                         break;
 313         }
 314 }
 315
 316 /** Main program entry point. This routine configures the hardware required by the application, then
 317  *  enters a loop to run the application tasks in sequence.
 318  */
 319 int main(void)
 320 {
 321         SetupHardware();
 322
 323         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 324         GlobalInterruptEnable();
 325
 326         while (RunBootloader)
 327         {
 328                 uint8_t BytesReceived = PRNT_Device_BytesReceived(&TextOnly_Printer_Interface);
 329
 330                 if (BytesReceived)
 331                 {
 332                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 333
 334                         while (BytesReceived--)
 335                         {
 336                                 int16_t ReceivedByte = PRNT_Device_ReceiveByte(&TextOnly_Printer_Interface);
 337
 338                                 /* Feed the next byte of data to the HEX parser */
 339                                 ParseIntelHEXByte(ReceivedByte);
 340                         }
 341
 342                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 343                 }
 344
 345                 PRNT_Device_USBTask(&TextOnly_Printer_Interface);
 346                 USB_USBTask();
 347         }
 348
 349         /* Disconnect from the host - USB interface will be reset later along with the AVR */
 350         USB_Detach();
 351
 352         /* Unlock the forced application start mode of the bootloader if it is restarted */
 353         MagicBootKey = MAGIC_BOOT_KEY;
 354
 355         /* Enable the watchdog and force a timeout to reset the AVR */
 356         wdt_enable(WDTO_250MS);
 357
 358         for (;;);
 359 }
 360
 361 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 362 static void SetupHardware(void)
 363 {
 364         /* Disable watchdog if enabled by bootloader/fuses */
 365         MCUSR &= ~(1 << WDRF);
 366         wdt_disable();
 367
 368         /* Disable clock division */
 369         clock_prescale_set(clock_div_1);
 370
 371         /* Relocate the interrupt vector table to the bootloader section */
 372         MCUCR = (1 << IVCE);
 373         MCUCR = (1 << IVSEL);
 374
 375         /* Hardware Initialization */
 376         LEDs_Init();
 377         USB_Init();
 378
 379         /* Bootloader active LED toggle timer initialization */
 380         TIMSK1 = (1 << TOIE1);
 381         TCCR1B = ((1 << CS11) | (1 << CS10));
 382 }
 383
 384 /** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
 385 ISR(TIMER1_OVF_vect, ISR_BLOCK)
 386 {
 387         LEDs_ToggleLEDs(LEDS_LED1 | LEDS_LED2);
 388 }
 389
 390 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
 391 void EVENT_USB_Device_Connect(void)
 392 {
 393         /* Indicate USB enumerating */
 394         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 395 }
 396
 397 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 398  *  the status LEDs and stops the Printer management task.
 399  */
 400 void EVENT_USB_Device_Disconnect(void)
 401 {
 402         /* Indicate USB not ready */
 403         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 404 }
 405
 406 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 407  *  of the USB device after enumeration - the device endpoints are configured and the Mass Storage management task started.
 408  */
 409 void EVENT_USB_Device_ConfigurationChanged(void)
 410 {
 411         bool ConfigSuccess = true;
 412
 413         /* Setup Printer Data Endpoints */
 414         ConfigSuccess &= PRNT_Device_ConfigureEndpoints(&TextOnly_Printer_Interface);
 415
 416         /* Indicate endpoint configuration success or failure */
 417         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 418 }
 419
 420 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 421  *  the device from the USB host before passing along unhandled control requests to the library for processing
 422  *  internally.
 423  */
 424 void EVENT_USB_Device_ControlRequest(void)
 425 {
 426         PRNT_Device_ProcessControlRequest(&TextOnly_Printer_Interface);
 427 }