proto.h

Go to the documentation of this file.

#ifndef _PROTO_H_
#define _PROTO_H_

/*
 * File Name: proto.h
 */

/*
 * This file is part of kbdupgrade.
 *
 * kbdupgrade is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * kbdupgrade 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */
 

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <stdint.h>


//----------------------------------------------------------------------------
// Macro Definitions
//---------------------------------------------------------------------------- 


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------


//---------------------------------------------------------------------------
// Global Constant
//----------------------------------------------------------------------------

#define IONKBD_START                  0xC0
#define IONKBD_ESC                    0xDB
#define IONKBD_ESC_START              0xDC
#define IONKBD_ESC_ESC                0xDD
                                      
#define IONKBD_REQ_GET_STATUS         0x04
#define IONKBD_REQ_SET_POWER          0x06
#define IONKBD_REQ_SET_MODE           0x07
#define IONKBD_REQ_GET_VERSION        0x08
#define IONKBD_REQ_GET_BATTERY        0x0A
#define IONKBD_REQ_ERASE_FLASH        0x0E
#define IONKBD_REQ_PROGRAM_FLASH      0x0F
#define IONKBD_REQ_READ_FLASH         0x10
#define IONKBD_REQ_FLASH_GASGAUGE     0x13
#define IONKBD_REQ_GET_GG_VERSION     0x14
#define IONKBD_REQ_GET_DEVICETYPE     0x19

#define IONKBD_REQ_ERASE_FLASH_BOOT   0x1F
#define IONKBD_REQ_PROGRAM_FLASH_BOOT 0x20
#define IONKBD_REQ_READ_FLASH_BOOT    0x21

#define IONKBD_RESP_STATUS            0x40
#define IONKBD_RESP_VERSION           0x41
#define IONKBD_RESP_BATTERY           0x43
#define IONKBD_RESP_ERASE             0x45
#define IONKBD_RESP_FLASH             0x46
#define IONKBD_RESP_READ              0x47
#define IONKBD_RESP_GASGAUGE          0x4A
#define IONKBD_RESP_GG_VERSION        0x4B
#define IONKBD_RESP_DEVICETYPE        0x4E
                                      
#define GASGAUGE_INIT                 0x00
#define GASGAUGE_START                0x01
#define GASGAUGE_SAVE_SETTINGS        0x02
#define GASGAUGE_ERASE                0x03
#define GASGAUGE_SETUP_ROW            0x04
#define GASGAUGE_PROGRAM_ROW          0x05
#define GASGAUGE_RESTORE_SETTINGS     0x06
#define GASGAUGE_STOP                 0x07

#define DR1000_APPL_ADDR_MIN    0x1800
#define DR1000_APPL_ADDR_MAX    0xE000

#define DR800_APPL_ADDR_MIN     0xC000
#define DR800_APPL_ADDR_MAX     0xE7FF

#define DR800_BOOT_ADDR_MIN     0xE800
#define DR800_BOOT_ADDR_MAX     0xFFFF

#define DEVICETYPE_ADDR         0x1040

#define MODE_BOOT                 0
#define MODE_APP                  1


//============================================================================
// Public Functions
//============================================================================

// Message printing
void fatalnum(int num, char *message, ...);
void fatal(char *message, ...);
void warning(char *message, ...);

// Basic packets
void ionkbd_send_packet(uint8_t cmd, uint8_t length, uint8_t *data);
int ionkbd_get_response(uint8_t *command, uint8_t *length, uint8_t *data);
int ionkbd_send_request(uint8_t cmd, uint8_t length, uint8_t *data, 
                        uint8_t *rcmd, uint8_t *rlen, uint8_t *rdata);
// Firmware programming
int sector_erase(int mode, uint16_t addr);
void micro_erase(int mode, uint16_t start, uint16_t end);
int chunk_program(int mode, uint16_t addr, uint8_t len, uint8_t *chunk);
int dr1000_micro_program_application(char* filename);
int dr800_micro_program_application(char* filename);
int dr800_micro_program_bootloader(char* filename);

// Device type
int micro_read_devicetype(int mode);
int micro_write_devicetype(int mode, int devtype);

// Version & mode
int micro_check_battery_charge(uint16_t min_level);
int micro_get_versions(uint16_t *bootloader, uint16_t *application);
void micro_enter_mode(uint8_t boot);
int micro_get_mode();
void micro_get_devicetype(uint8_t *type);

// Gasgauge
int gasgauge_get_versions(uint16_t *firmware, uint16_t *hardware);
int gasgauge_flash(char *filename);

// Open serial connection
void port_open(char* name, int flags, int speed);


#endif