Bootloaders/Printer/BootloaderPrinter.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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          = INTERFACE_ID_Printer,
  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 /** Indicates if there is data waiting to be written to a physical page of
  98  *  memory in FLASH.
  99  */
 100 static bool PageDirty = false;
 101
 102 /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
 103  *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
 104  *  started via a forced watchdog reset.
 105  */
 106 static bool RunBootloader = true;
 107
 108 /** Magic lock for forced application start. If the HWBE fuse is programmed and BOOTRST is unprogrammed, the bootloader
 109  *  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
 110  *  low when the application attempts to start via a watchdog reset, the bootloader will re-start. If set to the value
 111  *  \ref MAGIC_BOOT_KEY the special init function \ref Application_Jump_Check() will force the application to start.
 112  */
 113 uint16_t MagicBootKey ATTR_NO_INIT;
 114
 115
 116 /** Special startup routine to check if the bootloader was started via a watchdog reset, and if the magic application
 117  *  start key has been loaded into \ref MagicBootKey. If the bootloader started via the watchdog and the key is valid,
 118  *  this will force the user application to start via a software jump.
 119  */
 120 void Application_Jump_Check(void)
 121 {
 122         bool JumpToApplication = false;
 123
 124         #if (BOARD == BOARD_LEONARDO)
 125                 /* Enable pull-up on the IO13 pin so we can use it to select the mode */
 126                 PORTC |= (1 << 7);
 127                 Delay_MS(10);
 128
 129                 /* If IO13 is not jumpered to ground, start the user application instead */
 130                 JumpToApplication = ((PINC & (1 << 7)) != 0);
 131
 132                 /* Disable pull-up after the check has completed */
 133                 PORTC &= ~(1 << 7);
 134         #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
 135                 /* Disable JTAG debugging */
 136                 JTAG_DISABLE();
 137
 138                 /* Enable pull-up on the JTAG TCK pin so we can use it to select the mode */
 139                 PORTF |= (1 << 4);
 140                 Delay_MS(10);
 141
 142                 /* If the TCK pin is not jumpered to ground, start the user application instead */
 143                 JumpToApplication = ((PINF & (1 << 4)) != 0);
 144
 145                 /* Re-enable JTAG debugging */
 146                 JTAG_ENABLE();
 147         #else
 148                 /* Check if the device's BOOTRST fuse is set */
 149                 if (boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS) & FUSE_BOOTRST)
 150                 {
 151                         /* If the reset source was not an external reset or the key is correct, clear it and jump to the application */
 152                         if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY))
 153                           JumpToApplication = true;
 154
 155                         /* Clear reset source */
 156                         MCUSR &= ~(1 << EXTRF);
 157                 }
 158                 else
 159                 {
 160                         /* If the reset source was the bootloader and the key is correct, clear it and jump to the application;
 161                          * this can happen in the HWBE fuse is set, and the HBE pin is low during the watchdog reset */
 162                         if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
 163                                 JumpToApplication = true;
 164
 165                         /* Clear reset source */
 166                         MCUSR &= ~(1 << WDRF);
 167                 }
 168         #endif
 169
 170         /* Don't run the user application if the reset vector is blank (no app loaded) */
 171         bool ApplicationValid = (pgm_read_word_near(0) != 0xFFFF);
 172
 173         /* If a request has been made to jump to the user application, honor it */
 174         if (JumpToApplication && ApplicationValid)
 175         {
 176                 /* Turn off the watchdog */
 177                 MCUSR &= ~(1 << WDRF);
 178                 wdt_disable();
 179
 180                 /* Clear the boot key and jump to the user application */
 181                 MagicBootKey = 0;
 182
 183                 // cppcheck-suppress constStatement
 184                 ((void (*)(void))0x0000)();
 185         }
 186 }
 187
 188 /**
 189  * Converts a given input byte of data from an ASCII encoded HEX value to an integer value.
 190  *
 191  * \note Input HEX bytes are expected to be in uppercase only.
 192  *
 193  * \param[in] Byte  ASCII byte of data to convert
 194  *
 195  * \return Integer converted value of the input ASCII encoded HEX byte of data, or -1 if the
 196  *         input is not valid ASCII encoded HEX.
 197  */
 198 static int8_t HexToDecimal(const char Byte)
 199 {
 200         if ((Byte >= 'A') && (Byte <= 'F'))
 201           return (10 + (Byte - 'A'));
 202         else if ((Byte >= '0') && (Byte <= '9'))
 203           return (Byte - '0');
 204
 205         return -1;
 206 }
 207
 208 /**
 209  * Flushes a partially written page of data to physical FLASH, if a page
 210  * boundary has been crossed.
 211  *
 212  * \note If a page flush occurs the global HEX parser state is updated.
 213  */
 214 static void FlushPageIfRequired(void)
 215 {
 216         /* Abort if no data has been buffered for writing to the current page */
 217         if (!PageDirty)
 218           return;
 219
 220         /* Flush the FLASH page to physical memory if we are crossing a page boundary */
 221         uint32_t NewPageStartAddress = (HEXParser.CurrAddress & ~(SPM_PAGESIZE - 1));
 222         if (HEXParser.PageStartAddress != NewPageStartAddress)
 223         {
 224                 boot_page_write(HEXParser.PageStartAddress);
 225                 boot_spm_busy_wait();
 226
 227                 HEXParser.PageStartAddress = NewPageStartAddress;
 228
 229                 PageDirty = false;
 230         }
 231 }
 232
 233 /**
 234  * Parses an input Intel HEX formatted stream one character at a time, loading
 235  * the data contents into the device's internal FLASH memory.
 236  *
 237  * \param[in] ReadCharacter  Next input ASCII byte of data to parse
 238  */
 239 static void ParseIntelHEXByte(const char ReadCharacter)
 240 {
 241         /* Reset the line parser while waiting for a new line to start */
 242         if ((HEXParser.ParserState == HEX_PARSE_STATE_WAIT_LINE) || (ReadCharacter == ':'))
 243         {
 244                 HEXParser.Checksum     = 0;
 245                 HEXParser.CurrAddress  = HEXParser.CurrBaseAddress;
 246                 HEXParser.ReadMSB      = false;
 247
 248                 /* ASCII ':' indicates the start of a new HEX record */
 249                 if (ReadCharacter == ':')
 250                   HEXParser.ParserState = HEX_PARSE_STATE_BYTE_COUNT;
 251
 252                 return;
 253         }
 254
 255         /* Only allow ASCII HEX encoded digits, ignore all other characters */
 256         int8_t ReadCharacterDec = HexToDecimal(ReadCharacter);
 257         if (ReadCharacterDec < 0)
 258           return;
 259
 260         /* Read and convert the next nibble of data from the current character */
 261         HEXParser.Data    = (HEXParser.Data << 4) | ReadCharacterDec;
 262         HEXParser.ReadMSB = !HEXParser.ReadMSB;
 263
 264         /* Only process further when a full byte (two nibbles) have been read */
 265         if (HEXParser.ReadMSB)
 266           return;
 267
 268         /* Intel HEX checksum is for all fields except starting character and the
 269          * checksum itself
 270          */
 271         if (HEXParser.ParserState != HEX_PARSE_STATE_CHECKSUM)
 272           HEXParser.Checksum += HEXParser.Data;
 273
 274         switch (HEXParser.ParserState)
 275         {
 276                 case HEX_PARSE_STATE_BYTE_COUNT:
 277                         HEXParser.DataRem      = HEXParser.Data;
 278                         HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_HIGH;
 279                         break;
 280
 281                 case HEX_PARSE_STATE_ADDRESS_HIGH:
 282                         HEXParser.CurrAddress += ((uint16_t)HEXParser.Data << 8);
 283                         HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_LOW;
 284                         break;
 285
 286                 case HEX_PARSE_STATE_ADDRESS_LOW:
 287                         HEXParser.CurrAddress += HEXParser.Data;
 288                         HEXParser.ParserState  = HEX_PARSE_STATE_RECORD_TYPE;
 289                         break;
 290
 291                 case HEX_PARSE_STATE_RECORD_TYPE:
 292                         HEXParser.RecordType   = HEXParser.Data;
 293                         HEXParser.ParserState  = (HEXParser.DataRem ? HEX_PARSE_STATE_READ_DATA : HEX_PARSE_STATE_CHECKSUM);
 294                         break;
 295
 296                 case HEX_PARSE_STATE_READ_DATA:
 297                         /* Track the number of read data bytes in the record */
 298                         HEXParser.DataRem--;
 299
 300                         /* Protect the bootloader against being written to */
 301                         if (HEXParser.CurrAddress >= BOOT_START_ADDR)
 302                         {
 303                                 HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
 304                                 PageDirty = false;
 305                                 return;
 306                         }
 307
 308                         /* Wait for a machine word (two bytes) of data to be read */
 309                         if (HEXParser.DataRem & 0x01)
 310                         {
 311                                 HEXParser.PrevData = HEXParser.Data;
 312                                 break;
 313                         }
 314
 315                         /* Convert the last two received data bytes into a 16-bit word */
 316                         uint16_t NewDataWord = ((uint16_t)HEXParser.Data << 8) | HEXParser.PrevData;
 317
 318                         switch (HEXParser.RecordType)
 319                         {
 320                                 case HEX_RECORD_TYPE_Data:
 321                                         /* If we are writing to a new page, we need to erase it first */
 322                                         if (!(PageDirty))
 323                                         {
 324                                                 boot_page_erase(HEXParser.PageStartAddress);
 325                                                 boot_spm_busy_wait();
 326
 327                                                 PageDirty = true;
 328                                         }
 329
 330                                         /* Fill the FLASH memory buffer with the new word of data */
 331                                         boot_page_fill(HEXParser.CurrAddress, NewDataWord);
 332                                         HEXParser.CurrAddress += 2;
 333
 334                                         /* Flush the FLASH page to physical memory if we are crossing a page boundary */
 335                                         FlushPageIfRequired();
 336                                         break;
 337
 338                                 case HEX_RECORD_TYPE_ExtendedSegmentAddress:
 339                                         /* Extended address data - store the upper 12-bits of the new address */
 340                                         HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 4);
 341                                         break;
 342
 343                                 case HEX_RECORD_TYPE_ExtendedLinearAddress:
 344                                         /* Extended address data - store the upper 16-bits of the new address */
 345                                         HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 16);
 346                                         break;
 347                         }
 348
 349                         if (!HEXParser.DataRem)
 350                           HEXParser.ParserState = HEX_PARSE_STATE_CHECKSUM;
 351                         break;
 352
 353                 case HEX_PARSE_STATE_CHECKSUM:
 354                         /* Verify checksum of the completed record */
 355                         if (HEXParser.Data != ((~HEXParser.Checksum + 1) & 0xFF))
 356                           break;
 357
 358                         /* Flush the FLASH page to physical memory if we are crossing a page boundary */
 359                         FlushPageIfRequired();
 360
 361                         /* If end of the HEX file reached, the bootloader should exit at next opportunity */
 362                         if (HEXParser.RecordType == HEX_RECORD_TYPE_EndOfFile)
 363                           RunBootloader = false;
 364
 365                         break;
 366
 367                 default:
 368                         HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
 369                         break;
 370         }
 371 }
 372
 373 /** Main program entry point. This routine configures the hardware required by the application, then
 374  *  enters a loop to run the application tasks in sequence.
 375  */
 376 int main(void)
 377 {
 378         SetupHardware();
 379
 380         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 381         GlobalInterruptEnable();
 382
 383         while (RunBootloader)
 384         {
 385                 uint8_t BytesReceived = PRNT_Device_BytesReceived(&TextOnly_Printer_Interface);
 386
 387                 if (BytesReceived)
 388                 {
 389                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 390
 391                         while (BytesReceived--)
 392                         {
 393                                 int16_t ReceivedByte = PRNT_Device_ReceiveByte(&TextOnly_Printer_Interface);
 394
 395                                 /* Feed the next byte of data to the HEX parser */
 396                                 ParseIntelHEXByte(ReceivedByte);
 397                         }
 398
 399                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 400                 }
 401
 402                 PRNT_Device_USBTask(&TextOnly_Printer_Interface);
 403                 USB_USBTask();
 404         }
 405
 406         /* Disconnect from the host - USB interface will be reset later along with the AVR */
 407         USB_Detach();
 408
 409         /* Unlock the forced application start mode of the bootloader if it is restarted */
 410         MagicBootKey = MAGIC_BOOT_KEY;
 411
 412         /* Enable the watchdog and force a timeout to reset the AVR */
 413         wdt_enable(WDTO_250MS);
 414
 415         for (;;);
 416 }
 417
 418 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 419 static void SetupHardware(void)
 420 {
 421         /* Disable watchdog if enabled by bootloader/fuses */
 422         MCUSR &= ~(1 << WDRF);
 423         wdt_disable();
 424
 425         /* Disable clock division */
 426         clock_prescale_set(clock_div_1);
 427
 428         /* Relocate the interrupt vector table to the bootloader section */
 429         MCUCR = (1 << IVCE);
 430         MCUCR = (1 << IVSEL);
 431
 432         /* Hardware Initialization */
 433         LEDs_Init();
 434         USB_Init();
 435
 436         /* Bootloader active LED toggle timer initialization */
 437         TIMSK1 = (1 << TOIE1);
 438         TCCR1B = ((1 << CS11) | (1 << CS10));
 439 }
 440
 441 /** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
 442 ISR(TIMER1_OVF_vect, ISR_BLOCK)
 443 {
 444         LEDs_ToggleLEDs(LEDS_LED1 | LEDS_LED2);
 445 }
 446
 447 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
 448 void EVENT_USB_Device_Connect(void)
 449 {
 450         /* Indicate USB enumerating */
 451         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 452 }
 453
 454 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 455  *  the status LEDs and stops the Printer management task.
 456  */
 457 void EVENT_USB_Device_Disconnect(void)
 458 {
 459         /* Indicate USB not ready */
 460         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 461 }
 462
 463 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 464  *  of the USB device after enumeration - the device endpoints are configured and the Mass Storage management task started.
 465  */
 466 void EVENT_USB_Device_ConfigurationChanged(void)
 467 {
 468         bool ConfigSuccess = true;
 469
 470         /* Setup Printer Data Endpoints */
 471         ConfigSuccess &= PRNT_Device_ConfigureEndpoints(&TextOnly_Printer_Interface);
 472
 473         /* Reset the HEX parser upon successful connection to a host */
 474         HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
 475
 476         /* Indicate endpoint configuration success or failure */
 477         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 478 }
 479
 480 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 481  *  the device from the USB host before passing along unhandled control requests to the library for processing
 482  *  internally.
 483  */
 484 void EVENT_USB_Device_ControlRequest(void)
 485 {
 486         PRNT_Device_ProcessControlRequest(&TextOnly_Printer_Interface);
 487 }