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 /**
00045  * @brief   SSBootloaderComm Command handler class for bootloader routines on SmartSensor
00046  * @details
00047  */
00048 class SSBootloaderComm: public SensorComm
00049 {
00050 public:
00051 
00052     /* PUBLIC FUNCTION DECLARATIONS */
00053     /**
00054     * @brief    SSBootloaderComm constructor.
00055     *
00056     */
00057     SSBootloaderComm(USBSerial* USB, SSInterface* ssInterface, DSInterface* dsInterface);
00058 
00059     /**
00060     * @brief    Parses DeviceStudio-style commands.
00061     * @details  Parses and executes commands. Prints return code to i/o device.
00062     * @returns true if sensor acted upon the command, false if command was unknown
00063     */
00064     bool parse_command(const char* cmd);
00065 
00066 private:
00067 
00068     /* PRIVATE METHODS */
00069     int parse_auth(const char* cmd, uint8_t *auth_bytes);
00070     int parse_iv(const char* cmd, uint8_t* iv_bytes);
00071     void flash_page_data(void);
00072 
00073     /* PRIVATE TYPE DEFINITIONS */
00074     typedef enum _cmd_state_t {
00075         cmd_enter_bootldr=0,
00076         cmd_exit_bootldr,
00077         cmd_reset,
00078         cmd_page_size,
00079         cmd_num_pages,
00080         cmd_set_iv,
00081         cmd_set_auth,
00082         cmd_erase,
00083         cmd_flash,
00084         NUM_CMDS,
00085     } cmd_state_t;
00086 
00087     /* PRIVATE VARIABLES */
00088     USBSerial *m_USB;
00089     SSInterface *ss_int;
00090     DSInterface *ds_int;
00091 
00092     char bootldr_version[128];
00093 
00094     int num_pages;
00095     int page_size;
00096 
00097     bool got_page_size;
00098     bool sent_num_pages;
00099 
00100     /* PRIVATE CONST VARIABLES */
00101     static const int AES_NONCE_SIZE = 11;
00102     static const int AES_AUTH_SIZE = 16;
00103     static const int MAX_PAGE_SIZE = 8192;
00104     static const int CHECKBYTES_SIZE = 16;
00105 
00106 };
00107 
00108 #endif /* _SSBOOTLOADERCOMM_H_ */