Bootloaders/MassStorage/BootloaderAPI.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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  *  Bootloader user application API functions.
  34  */
  35
  36 #include "BootloaderAPI.h"
  37
  38 bool IsPageAddressValid(const uint32_t Address)
  39 {
  40         /* Determine if the given page address is correctly aligned to the
  41            start of a flash page.
  42
  43            Note that this is not static, as we need to force it into the
  44            AUX_BOOT_SECTION on small flash devices to save space.
  45         */
  46
  47         bool PageAddressIsAligned = !(Address & (SPM_PAGESIZE - 1));
  48
  49         return (Address < BOOT_START_ADDR) && PageAddressIsAligned;
  50 }
  51
  52 void BootloaderAPI_ErasePage(const uint32_t Address)
  53 {
  54         if (! IsPageAddressValid(Address))
  55                 return;
  56
  57         ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
  58         {
  59                 boot_page_erase_safe(Address);
  60                 boot_spm_busy_wait();
  61                 boot_rww_enable();
  62         }
  63 }
  64
  65 void BootloaderAPI_WritePage(const uint32_t Address)
  66 {
  67         if (! IsPageAddressValid(Address))
  68                 return;
  69
  70         ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
  71         {
  72                 boot_page_write_safe(Address);
  73                 boot_spm_busy_wait();
  74                 boot_rww_enable();
  75         }
  76 }
  77
  78 void BootloaderAPI_FillWord(const uint32_t Address, const uint16_t Word)
  79 {
  80         boot_page_fill_safe(Address, Word);
  81 }
  82
  83 uint8_t BootloaderAPI_ReadSignature(const uint16_t Address)
  84 {
  85         return boot_signature_byte_get(Address);
  86 }
  87
  88 uint8_t BootloaderAPI_ReadFuse(const uint16_t Address)
  89 {
  90         return boot_lock_fuse_bits_get(Address);
  91 }
  92
  93 uint8_t BootloaderAPI_ReadLock(void)
  94 {
  95         return boot_lock_fuse_bits_get(GET_LOCK_BITS);
  96 }
  97
  98 void BootloaderAPI_WriteLock(const uint8_t LockBits)
  99 {
 100         ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
 101         {
 102                 boot_lock_bits_set_safe(LockBits);
 103         }
 104 }