SFBBootBlock.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBBootBlock.h - Persistent boot-time information support
  Copyright (C) 2009 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA

  $Id$
*/

#ifndef SFBBOOTBLOCK_H
#define SFBBOOTBLOCK_H

#include "SFBChecksum.h"    /* For SFBChecksum */ 
#include "SFBTypes.h"       /* For u32 etc */
#include "SFBEeprom.h"      /* For EEPROM_RESERVED_BYTES */
#include "SFBPower.h"       /* For VOLTAGE_CALIBRATION_SIZE_BYTES */ 

#define BOOTBLOCK_MIN_VERSION 0x01  
#define BOOTBLOCK_MAX_VERSION 0xfe  
#define BOOTBLOCK_VERSION 6

struct SFBBootBlock {
  u8 version;             










  u8 writeTag;            


  u16 flags;              
  u32 bootCount;          
  u32 burnCount;          
  u32 ownerId;            
  u32 boardId;            
  u32 powerOnHours;       






  u8 initialPower;        

  u8 watchdogResets;      
  u8 voltageCalib[15];    
  u8 reservedPadding[15]; 
  SFBChecksum cs;         
};

typedef char ensureSFBBootBlockSizeIsTheRightSize[sizeof(SFBBootBlock) == EEPROM_BYTES_PER_PAGE];
typedef char ensureCorrectNumberOfPagesAreReserved[2 == EEPROM_RESERVED_PAGES];
enum SFBBootBlockFlag {
  BOOTBLOCK_INVALID =      0x0001, 
  BOOTBLOCK_BOOT_MODE =    0x0002, 
  BOOTBLOCK_BLUE_NOT_RED = 0x0004, 
  BOOTBLOCK_UNLOCKED =     0x0008, 

  BOOTBLOCK_NO_UPDATES =   0x0010, 
  BOOTBLOCK_KILL_SKETCH =  0x0020, 
  BOOTBLOCK_RSRVD06 =      0x0040, 
  BOOTBLOCK_RSRVD07 =      0x0080, 

  BOOTBLOCK_RSRVD08 =      0x0100, 
  BOOTBLOCK_RSRVD09 =      0x0200, 
  BOOTBLOCK_RSRVD10 =      0x0400, 
  BOOTBLOCK_RSRVD11 =      0x0800, 

  BOOTBLOCK_RSRVD12 =      0x1000, 
  BOOTBLOCK_RSRVD13 =      0x2000, 
  BOOTBLOCK_RSRVD14 =      0x4000, 
  BOOTBLOCK_RSRVD15 =      0x8000, 

  BOOTBLOCK_DEFINED_FLAGS =   
    BOOTBLOCK_INVALID | BOOTBLOCK_BOOT_MODE | BOOTBLOCK_BLUE_NOT_RED | BOOTBLOCK_UNLOCKED
  | BOOTBLOCK_NO_UPDATES | BOOTBLOCK_KILL_SKETCH
};

extern u32 getBootBlockVersion() ;  


extern u8 getBootBlockWatchdogResets() ;  

extern u32 getBootBlockOwnerId() ;  
extern u32 getBootBlockBoardId() ;  
extern u32 getBootBlockBootCount() ;  
extern u32 getBootBlockBurnCount() ;  
extern u32 getBootBlockPowerOnHours() ;  




extern u32 getBootBlockFlags() ;         
extern u32 getBootBlockBootMode() ;      




extern u32 getBootBlockMergedChecksum() ; 



extern bool getBootBlockPowerIn(u8 face) ; 








extern bool getBootBlockPowerOut(u8 face) ; 





extern void setBootBlockPowerIn(u8 face, bool accept) ; 




extern void setBootBlockPowerOut(u8 face, bool provide) ; 




extern const char * bootModeColorName(u32 bootMode) ;

extern u32 getBootBlockBootLoaderLength() ; 


extern u32 getBootBlockBootLoaderBurnCount() ; 







extern void getBootBlockBootLoaderChecksum(SFBChecksum cs) ; 






extern void setBootBlockWatchdogResetFlag(bool bootedClean) ; 



extern void setBootBlockOwnerId(u32 newOwnerId) ;             


extern void setBootBlockBoardId(u32 newBoardId) ;             


extern void incrementBootBlockBootCount() ;         
extern void incrementBootBlockBurnCount() ;         
extern void incrementBootBlockPowerOnHours() ;      
extern void setBootBlockFlags(u32 newFlags) ;       
extern void setBootBlockBootMode(u32 newBootMode) ; 

extern void getBootBlockVoltageCalibrationData(u8 data[VOLTAGE_CALIBRATION_SIZE_BYTES]) ;

extern void setBootBlockVoltageCalibrationData(u8 data[VOLTAGE_CALIBRATION_SIZE_BYTES]) ;

/* The one-time serial startup code */
extern void bootblock_startup_initialization() ;

/* Increment the bootcount at startup (unless overridden) */
extern void bootblock_bootcount_initialization() __attribute__ ((weak));  /* Allow overriding this initialization step */
#endif  /* SFBBOOTBLOCK_H */