BootloaderPrinter.c 15.3 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2018.
4
5
6
7
8
9

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

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2018  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

  Permission to use, copy, modify, distribute, and sell this
  software and its documentation for any purpose is hereby granted
  without fee, 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 disclaims 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
 *
 *  Main source file for the Printer class bootloader. This file contains the complete bootloader logic.
 */

#include "BootloaderPrinter.h"

38
39
40
41
42
43
44
45
/** 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 =
			{
46
				.InterfaceNumber          = INTERFACE_ID_Printer,
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
				.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",
			},
	};

67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/** Intel HEX parser state machine state information, to track the contents of
 *  a HEX file streamed in as a sequence of arbitrary bytes.
 */
struct
{
	/** Current HEX parser state machine state. */
	uint8_t  ParserState;
	/** Previously decoded numerical byte of data. */
	uint8_t  PrevData;
	/** Currently decoded numerical byte of data. */
	uint8_t  Data;
	/** Indicates if both bytes that correspond to a single decoded numerical
	 *  byte of data (HEX encodes values in ASCII HEX, two characters per byte)
	 *  have been read.
	 */
	bool     ReadMSB;
	/** Intel HEX record type of the current Intel HEX record. */
	uint8_t  RecordType;
	/** Numerical bytes of data remaining to be read in the current record. */
	uint8_t  DataRem;
	/** Checksum of the current record received so far. */
	uint8_t  Checksum;
	/** Starting address of the last addressed FLASH page. */
	uint32_t PageStartAddress;
91
92
	/** Current 32-bit byte extended base address in FLASH being targeted. */
	uint32_t CurrBaseAddress;
93
94
	/** Current 32-bit byte address in FLASH being targeted. */
	uint32_t CurrAddress;
95
} HEXParser;
96
97
98
99
100
101

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

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/** 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.
 */
void Application_Jump_Check(void)
{
122
123
124
125
	bool JumpToApplication = false;

	#if (BOARD == BOARD_LEONARDO)
		/* Enable pull-up on the IO13 pin so we can use it to select the mode */
126
		PORTC |= (1 << 7);
127
128
129
		Delay_MS(10);

		/* If IO13 is not jumpered to ground, start the user application instead */
130
		JumpToApplication = ((PINC & (1 << 7)) != 0);
131
132
133
134
135
136
137
138
139
140
141
142

		/* Disable pull-up after the check has completed */
		PORTC &= ~(1 << 7);
	#elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
		/* Disable JTAG debugging */
		JTAG_DISABLE();

		/* Enable pull-up on the JTAG TCK pin so we can use it to select the mode */
		PORTF |= (1 << 4);
		Delay_MS(10);

		/* If the TCK pin is not jumpered to ground, start the user application instead */
143
		JumpToApplication = ((PINF & (1 << 4)) != 0);
144
145
146

		/* Re-enable JTAG debugging */
		JTAG_ENABLE();
147
148
	#else
		/* Check if the device's BOOTRST fuse is set */
149
		if (!(BootloaderAPI_ReadFuse(GET_HIGH_FUSE_BITS) & ~FUSE_BOOTRST))
150
151
152
153
154
		{
			/* If the reset source was not an external reset or the key is correct, clear it and jump to the application */
			if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY))
			  JumpToApplication = true;

155
			/* Clear reset source */
156
157
			MCUSR &= ~(1 << EXTRF);
		}
158
159
160
161
162
163
164
165
166
167
		else
		{
			/* If the reset source was the bootloader and the key is correct, clear it and jump to the application;
			 * this can happen in the HWBE fuse is set, and the HBE pin is low during the watchdog reset */
			if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
				JumpToApplication = true;

			/* Clear reset source */
			MCUSR &= ~(1 << WDRF);
		}
168
169
170
	#endif

	/* 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
179
180
		wdt_disable();

		/* Clear the boot key and jump to the user application */
181
182
183
184
185
186
187
		MagicBootKey = 0;

		// cppcheck-suppress constStatement
		((void (*)(void))0x0000)();
	}
}

188
189
190
191
192
193
194
/**
 * 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
 *
195
196
 * \return Integer converted value of the input ASCII encoded HEX byte of data, or -1 if the
 *         input is not valid ASCII encoded HEX.
197
 */
198
static int8_t HexToDecimal(const char Byte)
199
200
201
202
203
204
{
	if ((Byte >= 'A') && (Byte <= 'F'))
	  return (10 + (Byte - 'A'));
	else if ((Byte >= '0') && (Byte <= '9'))
	  return (Byte - '0');

205
	return -1;
206
207
}

208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/**
 * 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)
	{
224
		BootloaderAPI_WritePage(HEXParser.PageStartAddress);
225
226
227
228
229
230
231

		HEXParser.PageStartAddress = NewPageStartAddress;

		PageDirty = false;
	}
}

232
233
234
235
236
237
238
239
/**
 * Parses an input Intel HEX formatted stream one character at a time, loading
 * the data contents into the device's internal FLASH memory.
 *
 * \param[in] ReadCharacter  Next input ASCII byte of data to parse
 */
static void ParseIntelHEXByte(const char ReadCharacter)
{
240
	/* Reset the line parser while waiting for a new line to start */
241
242
243
	if ((HEXParser.ParserState == HEX_PARSE_STATE_WAIT_LINE) || (ReadCharacter == ':'))
	{
		HEXParser.Checksum     = 0;
244
		HEXParser.CurrAddress  = HEXParser.CurrBaseAddress;
245
246
		HEXParser.ReadMSB      = false;

247
		/* ASCII ':' indicates the start of a new HEX record */
248
249
250
251
252
253
		if (ReadCharacter == ':')
		  HEXParser.ParserState = HEX_PARSE_STATE_BYTE_COUNT;

		return;
	}

254
	/* Only allow ASCII HEX encoded digits, ignore all other characters */
255
256
	int8_t ReadCharacterDec = HexToDecimal(ReadCharacter);
	if (ReadCharacterDec < 0)
257
258
	  return;

259
	/* Read and convert the next nibble of data from the current character */
260
	HEXParser.Data    = (HEXParser.Data << 4) | ReadCharacterDec;
261
262
	HEXParser.ReadMSB = !HEXParser.ReadMSB;

263
	/* Only process further when a full byte (two nibbles) have been read */
264
265
266
	if (HEXParser.ReadMSB)
	  return;

267
268
269
	/* Intel HEX checksum is for all fields except starting character and the
	 * checksum itself
	 */
270
271
272
273
274
275
276
277
278
279
280
	if (HEXParser.ParserState != HEX_PARSE_STATE_CHECKSUM)
	  HEXParser.Checksum += HEXParser.Data;

	switch (HEXParser.ParserState)
	{
		case HEX_PARSE_STATE_BYTE_COUNT:
			HEXParser.DataRem      = HEXParser.Data;
			HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_HIGH;
			break;

		case HEX_PARSE_STATE_ADDRESS_HIGH:
281
			HEXParser.CurrAddress += ((uint16_t)HEXParser.Data << 8);
282
283
284
285
			HEXParser.ParserState  = HEX_PARSE_STATE_ADDRESS_LOW;
			break;

		case HEX_PARSE_STATE_ADDRESS_LOW:
286
			HEXParser.CurrAddress += HEXParser.Data;
287
288
289
290
291
292
293
294
295
			HEXParser.ParserState  = HEX_PARSE_STATE_RECORD_TYPE;
			break;

		case HEX_PARSE_STATE_RECORD_TYPE:
			HEXParser.RecordType   = HEXParser.Data;
			HEXParser.ParserState  = (HEXParser.DataRem ? HEX_PARSE_STATE_READ_DATA : HEX_PARSE_STATE_CHECKSUM);
			break;

		case HEX_PARSE_STATE_READ_DATA:
296
			/* Track the number of read data bytes in the record */
297
298
			HEXParser.DataRem--;

299
300
301
302
303
304
305
306
			/* Protect the bootloader against being written to */
			if (HEXParser.CurrAddress >= BOOT_START_ADDR)
			{
				HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
				PageDirty = false;
				return;
			}

307
			/* Wait for a machine word (two bytes) of data to be read */
308
309
310
311
312
313
			if (HEXParser.DataRem & 0x01)
			{
				HEXParser.PrevData = HEXParser.Data;
				break;
			}

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

317
318
319
			switch (HEXParser.RecordType)
			{
				case HEX_RECORD_TYPE_Data:
320
					/* If we are writing to a new page, we need to erase it first */
321
322
					if (!(PageDirty))
					{
323
						BootloaderAPI_ErasePage(HEXParser.PageStartAddress);
324
325
326
327

						PageDirty = true;
					}

328
					/* Fill the FLASH memory buffer with the new word of data */
329
					BootloaderAPI_FillWord(HEXParser.CurrAddress, NewDataWord);
330
331
					HEXParser.CurrAddress += 2;

332
					/* Flush the FLASH page to physical memory if we are crossing a page boundary */
333
					FlushPageIfRequired();
334
335
					break;

336
337
				case HEX_RECORD_TYPE_ExtendedSegmentAddress:
					/* Extended address data - store the upper 12-bits of the new address */
338
					HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 4);
339
340
					break;

341
				case HEX_RECORD_TYPE_ExtendedLinearAddress:
342
					/* Extended address data - store the upper 16-bits of the new address */
343
					HEXParser.CurrBaseAddress = ((uint32_t)NewDataWord << 16);
344
345
346
347
348
349
350
351
					break;
			}

			if (!HEXParser.DataRem)
			  HEXParser.ParserState = HEX_PARSE_STATE_CHECKSUM;
			break;

		case HEX_PARSE_STATE_CHECKSUM:
352
			/* Verify checksum of the completed record */
353
354
355
			if (HEXParser.Data != ((~HEXParser.Checksum + 1) & 0xFF))
			  break;

356
			/* Flush the FLASH page to physical memory if we are crossing a page boundary */
357
			FlushPageIfRequired();
358

359
360
361
362
			/* If end of the HEX file reached, the bootloader should exit at next opportunity */
			if (HEXParser.RecordType == HEX_RECORD_TYPE_EndOfFile)
			  RunBootloader = false;

363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
			break;

		default:
			HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;
			break;
	}
}

/** Main program entry point. This routine configures the hardware required by the application, then
 *  enters a loop to run the application tasks in sequence.
 */
int main(void)
{
	SetupHardware();

	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
	GlobalInterruptEnable();

381
	while (RunBootloader)
382
	{
383
		uint8_t BytesReceived = PRNT_Device_BytesReceived(&TextOnly_Printer_Interface);
384

385
386
387
		if (BytesReceived)
		{
			LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
388

389
			while (BytesReceived--)
390
			{
391
392
				int16_t ReceivedByte = PRNT_Device_ReceiveByte(&TextOnly_Printer_Interface);

393
				/* Feed the next byte of data to the HEX parser */
394
				ParseIntelHEXByte(ReceivedByte);
395
396
397
398
			}

			LEDs_SetAllLEDs(LEDMASK_USB_READY);
		}
399
400
401

		PRNT_Device_USBTask(&TextOnly_Printer_Interface);
		USB_USBTask();
402
	}
403

404
405
406
	/* Wait a short time to end all USB transactions and then disconnect */
	_delay_us(1000);

407
408
409
410
411
412
413
414
415
416
	/* 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 (;;);
417
418
419
}

/** Configures the board hardware and chip peripherals for the demo's functionality. */
420
static void SetupHardware(void)
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

	/* Disable clock division */
	clock_prescale_set(clock_div_1);

	/* Relocate the interrupt vector table to the bootloader section */
	MCUCR = (1 << IVCE);
	MCUCR = (1 << IVSEL);

	/* Hardware Initialization */
	LEDs_Init();
	USB_Init();
436
437
438
439
440
441
442
443
444
445

	/* 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);
446
447
448
449
450
451
452
453
454
455
}

/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
void EVENT_USB_Device_Connect(void)
{
	/* Indicate USB enumerating */
	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
}

/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
456
 *  the status LEDs and stops the Printer management task.
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 */
void EVENT_USB_Device_Disconnect(void)
{
	/* Indicate USB not ready */
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
}

/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 *  of the USB device after enumeration - the device endpoints are configured and the Mass Storage management task started.
 */
void EVENT_USB_Device_ConfigurationChanged(void)
{
	bool ConfigSuccess = true;

	/* Setup Printer Data Endpoints */
472
	ConfigSuccess &= PRNT_Device_ConfigureEndpoints(&TextOnly_Printer_Interface);
473

474
475
476
	/* Reset the HEX parser upon successful connection to a host */
	HEXParser.ParserState = HEX_PARSE_STATE_WAIT_LINE;

477
478
479
480
481
482
483
484
485
486
	/* Indicate endpoint configuration success or failure */
	LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
}

/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 *  the device from the USB host before passing along unhandled control requests to the library for processing
 *  internally.
 */
void EVENT_USB_Device_ControlRequest(void)
{
487
	PRNT_Device_ProcessControlRequest(&TextOnly_Printer_Interface);
488
}