Add bootloader API functions to the Printer class bootloader.
This commit is contained in:
		
							parent
							
								
									63e80bea08
								
							
						
					
					
						commit
						041bdf8954
					
				
					 4 changed files with 230 additions and 1 deletions
				
			
		
							
								
								
									
										75
									
								
								Bootloaders/Printer/BootloaderAPI.c
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										75
									
								
								Bootloaders/Printer/BootloaderAPI.c
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,75 @@
 | 
			
		|||
/*
 | 
			
		||||
             LUFA Library
 | 
			
		||||
     Copyright (C) Dean Camera, 2013.
 | 
			
		||||
 | 
			
		||||
  dean [at] fourwalledcubicle [dot] com
 | 
			
		||||
           www.lufa-lib.org
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
  Copyright 2013  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
 | 
			
		||||
  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
 | 
			
		||||
 *
 | 
			
		||||
 *  Bootloader user application API functions.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#include "BootloaderAPI.h"
 | 
			
		||||
 | 
			
		||||
void BootloaderAPI_ErasePage(const uint32_t Address)
 | 
			
		||||
{
 | 
			
		||||
	boot_page_erase_safe(Address);
 | 
			
		||||
	boot_spm_busy_wait();
 | 
			
		||||
	boot_rww_enable();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BootloaderAPI_WritePage(const uint32_t Address)
 | 
			
		||||
{
 | 
			
		||||
	boot_page_write_safe(Address);
 | 
			
		||||
	boot_spm_busy_wait();
 | 
			
		||||
	boot_rww_enable();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BootloaderAPI_FillWord(const uint32_t Address, const uint16_t Word)
 | 
			
		||||
{
 | 
			
		||||
	boot_page_fill_safe(Address, Word);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t BootloaderAPI_ReadSignature(const uint16_t Address)
 | 
			
		||||
{
 | 
			
		||||
	return boot_signature_byte_get(Address);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t BootloaderAPI_ReadFuse(const uint16_t Address)
 | 
			
		||||
{
 | 
			
		||||
	return boot_lock_fuse_bits_get(Address);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t BootloaderAPI_ReadLock(void)
 | 
			
		||||
{
 | 
			
		||||
	return boot_lock_fuse_bits_get(GET_LOCK_BITS);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BootloaderAPI_WriteLock(const uint8_t LockBits)
 | 
			
		||||
{
 | 
			
		||||
	boot_lock_bits_set_safe(LockBits);
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										56
									
								
								Bootloaders/Printer/BootloaderAPI.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								Bootloaders/Printer/BootloaderAPI.h
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,56 @@
 | 
			
		|||
/*
 | 
			
		||||
             LUFA Library
 | 
			
		||||
     Copyright (C) Dean Camera, 2013.
 | 
			
		||||
 | 
			
		||||
  dean [at] fourwalledcubicle [dot] com
 | 
			
		||||
           www.lufa-lib.org
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
  Copyright 2013  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
 | 
			
		||||
  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
 | 
			
		||||
 *
 | 
			
		||||
 *  Header file for BootloaderAPI.c.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#ifndef _BOOTLOADER_API_H_
 | 
			
		||||
#define _BOOTLOADER_API_H_
 | 
			
		||||
 | 
			
		||||
	/* Includes: */
 | 
			
		||||
		#include <avr/io.h>
 | 
			
		||||
		#include <avr/boot.h>
 | 
			
		||||
		#include <stdbool.h>
 | 
			
		||||
 | 
			
		||||
		#include <LUFA/Common/Common.h>
 | 
			
		||||
 | 
			
		||||
	/* Function Prototypes: */
 | 
			
		||||
		void    BootloaderAPI_ErasePage(const uint32_t Address);
 | 
			
		||||
		void    BootloaderAPI_WritePage(const uint32_t Address);
 | 
			
		||||
		void    BootloaderAPI_FillWord(const uint32_t Address, const uint16_t Word);
 | 
			
		||||
		uint8_t BootloaderAPI_ReadSignature(const uint16_t Address);
 | 
			
		||||
		uint8_t BootloaderAPI_ReadFuse(const uint16_t Address);
 | 
			
		||||
		uint8_t BootloaderAPI_ReadLock(void);
 | 
			
		||||
		void    BootloaderAPI_WriteLock(const uint8_t LockBits);
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										91
									
								
								Bootloaders/Printer/BootloaderAPITable.S
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										91
									
								
								Bootloaders/Printer/BootloaderAPITable.S
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,91 @@
 | 
			
		|||
/*
 | 
			
		||||
             LUFA Library
 | 
			
		||||
     Copyright (C) Dean Camera, 2013.
 | 
			
		||||
 | 
			
		||||
  dean [at] fourwalledcubicle [dot] com
 | 
			
		||||
           www.lufa-lib.org
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
  Copyright 2011  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
 | 
			
		||||
  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.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
; Trampolines to actual API implementations if the target address is outside the
 | 
			
		||||
; range of a rjmp instruction (can happen with large bootloader sections)
 | 
			
		||||
.section .apitable_trampolines, "ax"
 | 
			
		||||
.global BootloaderAPI_Trampolines
 | 
			
		||||
BootloaderAPI_Trampolines:
 | 
			
		||||
 | 
			
		||||
	BootloaderAPI_ErasePage_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_ErasePage
 | 
			
		||||
	BootloaderAPI_WritePage_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_WritePage
 | 
			
		||||
	BootloaderAPI_FillWord_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_FillWord
 | 
			
		||||
	BootloaderAPI_ReadSignature_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_ReadSignature
 | 
			
		||||
	BootloaderAPI_ReadFuse_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_ReadFuse
 | 
			
		||||
	BootloaderAPI_ReadLock_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_ReadLock
 | 
			
		||||
	BootloaderAPI_WriteLock_Trampoline:
 | 
			
		||||
		jmp BootloaderAPI_WriteLock
 | 
			
		||||
	BootloaderAPU_UNUSED1:
 | 
			
		||||
		ret
 | 
			
		||||
	BootloaderAPU_UNUSED2:
 | 
			
		||||
		ret
 | 
			
		||||
	BootloaderAPU_UNUSED3:
 | 
			
		||||
		ret
 | 
			
		||||
	BootloaderAPU_UNUSED4:
 | 
			
		||||
		ret
 | 
			
		||||
	BootloaderAPU_UNUSED5:
 | 
			
		||||
		ret
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
; API function jump table
 | 
			
		||||
.section .apitable_jumptable, "ax"
 | 
			
		||||
.global BootloaderAPI_JumpTable
 | 
			
		||||
BootloaderAPI_JumpTable:
 | 
			
		||||
 | 
			
		||||
	rjmp BootloaderAPI_ErasePage_Trampoline
 | 
			
		||||
	rjmp BootloaderAPI_WritePage_Trampoline
 | 
			
		||||
	rjmp BootloaderAPI_FillWord_Trampoline
 | 
			
		||||
	rjmp BootloaderAPI_ReadSignature_Trampoline
 | 
			
		||||
	rjmp BootloaderAPI_ReadFuse_Trampoline
 | 
			
		||||
	rjmp BootloaderAPI_ReadLock_Trampoline
 | 
			
		||||
	rjmp BootloaderAPI_WriteLock_Trampoline
 | 
			
		||||
	rjmp BootloaderAPU_UNUSED1 ; UNUSED ENTRY 1
 | 
			
		||||
	rjmp BootloaderAPU_UNUSED2 ; UNUSED ENTRY 2
 | 
			
		||||
	rjmp BootloaderAPU_UNUSED3 ; UNUSED ENTRY 3
 | 
			
		||||
	rjmp BootloaderAPU_UNUSED4 ; UNUSED ENTRY 4
 | 
			
		||||
	rjmp BootloaderAPU_UNUSED5 ; UNUSED ENTRY 5
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
; Bootloader table signatures and information
 | 
			
		||||
.section .apitable_signatures, "ax"
 | 
			
		||||
.global BootloaderAPI_Signatures
 | 
			
		||||
BootloaderAPI_Signatures:
 | 
			
		||||
 | 
			
		||||
	.long BOOT_START_ADDR ; Start address of the bootloader
 | 
			
		||||
	.word 0xDF20 ; Signature for the Printer class bootloader
 | 
			
		||||
	.word 0xDCFB ; Signature for a LUFA class bootloader
 | 
			
		||||
| 
						 | 
				
			
			@ -18,7 +18,7 @@ F_CPU        = 8000000
 | 
			
		|||
F_USB        = $(F_CPU)
 | 
			
		||||
OPTIMIZATION = s
 | 
			
		||||
TARGET       = BootloaderPrinter
 | 
			
		||||
SRC          = $(TARGET).c Descriptors.c $(LUFA_SRC_USB)
 | 
			
		||||
SRC          = $(TARGET).c Descriptors.c BootloaderAPI.c BootloaderAPITable.S $(LUFA_SRC_USB)
 | 
			
		||||
LUFA_PATH    = ../../LUFA
 | 
			
		||||
CC_FLAGS     = -DUSE_LUFA_CONFIG_HEADER -IConfig/ -DBOOT_START_ADDR=$(BOOT_START_OFFSET)
 | 
			
		||||
LD_FLAGS     = -Wl,--section-start=.text=$(BOOT_START_OFFSET) $(BOOT_API_LD_FLAGS)
 | 
			
		||||
| 
						 | 
				
			
			@ -35,6 +35,13 @@ CALC_ADDRESS_IN_HEX   = $(shell printf "0x%X" $$(( $(1) )) )
 | 
			
		|||
BOOT_START_OFFSET     = $(call CALC_ADDRESS_IN_HEX, ($(FLASH_SIZE_KB) - $(BOOT_SECTION_SIZE_KB)) * 1024 )
 | 
			
		||||
BOOT_SEC_OFFSET       = $(call CALC_ADDRESS_IN_HEX, ($(FLASH_SIZE_KB) * 1024) - $(strip $(1)) )
 | 
			
		||||
 | 
			
		||||
# Bootloader linker section flags for relocating the API table sections to
 | 
			
		||||
# known FLASH addresses - these should not normally be user-edited.
 | 
			
		||||
BOOT_SECTION_LD_FLAG  = -Wl,--section-start=.apitable_$(strip $(1))=$(call BOOT_SEC_OFFSET, $(3)) -Wl,--undefined=BootloaderAPI_$(strip $(2))
 | 
			
		||||
BOOT_API_LD_FLAGS     = $(call BOOT_SECTION_LD_FLAG, trampolines, Trampolines, 96)
 | 
			
		||||
BOOT_API_LD_FLAGS    += $(call BOOT_SECTION_LD_FLAG, jumptable,   JumpTable,   32)
 | 
			
		||||
BOOT_API_LD_FLAGS    += $(call BOOT_SECTION_LD_FLAG, signatures,  Signatures,  8)
 | 
			
		||||
 | 
			
		||||
# Default target
 | 
			
		||||
all:
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue