SSBootloaderComm.h

00001 /*******************************************************************************
00002  * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 
00034 #ifndef _SSBOOTLOADERCOMM_H_
00035 #define _SSBOOTLOADERCOMM_H_
00036 
00037 #include "mbed.h"
00038 #include "SensorComm.h"
00039 #include "USBSerial.h"
00040 #include "SSInterface.h"
00041 
00042 #define SS_BOOTLOADER_ERASE_DELAY   2000
00043 
00044 #define PAGE_WRITE_DELAY_MS         700
00045 #define MAX_PAGE_NUMBER             31
00046 
00047 /**
00048  * @brief   SSBootloaderComm Command handler class for bootloader routines on SmartSensor
00049  * @details
00050  */
00051 class SSBootloaderComm: public SensorComm
00052 {
00053 public:
00054 
00055     /* PUBLIC FUNCTION DECLARATIONS */
00056     /**
00057     * @brief    SSBootloaderComm constructor.
00058     *
00059     */
00060     SSBootloaderComm(USBSerial* USB, SSInterface* ssInterface, DSInterface* dsInterface);
00061 
00062     /**
00063     * @brief    Parses DeviceStudio-style commands.
00064     * @details  Parses and executes commands. Prints return code to i/o device.
00065     * @returns true if sensor acted upon the command, false if command was unknown
00066     */
00067     bool parse_command(const char* cmd);
00068 
00069 private:
00070 
00071     /* PRIVATE METHODS */
00072     int parse_auth(const char* cmd, uint8_t *auth_bytes);
00073     int parse_iv(const char* cmd, uint8_t* iv_bytes);
00074     void flash_page_data(void);
00075 
00076     /* PRIVATE TYPE DEFINITIONS */
00077     typedef enum _cmd_state_t {
00078         cmd_enter_bootldr=0,
00079         cmd_exit_bootldr,
00080         cmd_reset,
00081         cmd_page_size,
00082         cmd_num_pages,
00083         cmd_set_iv,
00084         cmd_set_auth,
00085         cmd_erase,
00086         cmd_page_erase,
00087         cmd_flash,
00088         cmd_setcfg_bl_enter_mode,
00089         cmd_setcfg_bl_ebl_pin,
00090         cmd_setcfg_bl_ebl_pol,
00091         cmd_setcfg_bl_exit_mode,
00092         cmd_setcfg_bl_timeout,
00093         cmd_setcfg_bl_save,
00094         cmd_image_on_ram,
00095         cmd_setcfg_host_ebl,
00096         cmd_setcfg_host_cdf,
00097         cmd_getcfg_host,
00098         NUM_CMDS,
00099     } cmd_state_t;
00100 
00101     /* PRIVATE VARIABLES */
00102     USBSerial *m_USB;
00103     SSInterface *ss_int;
00104     DSInterface *ds_int;
00105 
00106     char bootldr_version[128];
00107 
00108     int num_pages;
00109     int page_size;
00110     int bl_comm_delay_factor;
00111 
00112     bool got_page_size;
00113     bool sent_num_pages;
00114 
00115     /* PRIVATE CONST VARIABLES */
00116     static const int AES_NONCE_SIZE = 11;
00117     static const int AES_AUTH_SIZE = 16;
00118     static const int MAX_PAGE_SIZE = 8192;
00119     static const int CHECKBYTES_SIZE = 16;
00120 
00121 };
00122 
00123 #endif /* _SSBOOTLOADERCOMM_H_ */