alan broad / Mbed OS carbon_v5_arm_studio

arm studio build

Dependencies:   libxDot-mbed5

inc/commI2C.h@9:cc23b2049639, 2018-08-13 (annotated)

Committer:
alan1974
Date:
Mon Aug 13 15:58:00 2018 +0000
Revision:
9:cc23b2049639
Parent:
7:fba1e8fc7693
Child:
12:7944e4dbe853
udpate

Who changed what in which revision?

UserRevisionLine numberNew contents of line
alan1974 0:a91cd1b08360 1 /*
alan1974 0:a91cd1b08360 2 * WaterBit, Inc. ("COMPANY") CONFIDENTIAL
alan1974 0:a91cd1b08360 3 * Unpublished Copyright (c) 2015-2016 WaterBit, Inc, All Rights Reserved.
alan1974 0:a91cd1b08360 4 * NOTICE: All information contained herein is, and remains the property of COMPANY. The intellectual and technical concepts contained herein are proprietary to COMPANY and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.
alan1974 0:a91cd1b08360 5 *
alan1974 0:a91cd1b08360 6 * Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from COMPANY.
alan1974 0:a91cd1b08360 7 *
alan1974 0:a91cd1b08360 8 * Access to the source code contained herein is hereby forbidden to anyone except current COMPANY employees, managers or contractors who have executed Confidentiality and Non-disclosure agreements explicitly covering such access.
alan1974 0:a91cd1b08360 9 *
alan1974 0:a91cd1b08360 10 * The copyright notice above does not evidence any actual or intended publication or disclosure of this source code, which includes information that is confidential and/or proprietary, and is a trade secret, of COMPANY.
alan1974 0:a91cd1b08360 11 *
alan1974 0:a91cd1b08360 12 * ANY REPRODUCTION, MODIFICATION, DISTRIBUTION, PUBLICPE RFORMANCE, OR PUBLIC DISPLAY OF OR THROUGH USE OF THIS SOURCE CODE WITHOUT THE EXPRESS WRITTEN CONSENT OF COMPANY IS STRICTLY PROHIBITED, AND IN VIOLATION OF APPLICABLE LAWS AND INTERNATIONAL TREATIES. THE RECEIPT OR POSSESSION OF THIS SOURCE CODE AND/OR RELATED INFORMATION DOES NOT CONVEY OR IMPLY ANY RIGHTS TO REPRODUCE, DISCLOSE OR DISTRIBUTE ITS CONTENTS, OR TO MANUFACTURE, USE, OR SELL ANYTHING THAT IT MAY DESCRIBE, IN WHOLE OR IN PART.
alan1974 0:a91cd1b08360 13 */
alan1974 0:a91cd1b08360 14
alan1974 0:a91cd1b08360 15 #ifndef _COMMI2C_H_
alan1974 0:a91cd1b08360 16 #define _COMMi2C_H_
alan1974 0:a91cd1b08360 17
alan1974 0:a91cd1b08360 18 #include "mbed.h"
alan1974 1:0d25d9ddbe9f 19 #include "global.h"
alan1974 0:a91cd1b08360 20
alan1974 0:a91cd1b08360 21
alan1974 0:a91cd1b08360 22
alan1974 0:a91cd1b08360 23 #define BUFFER_SIZE_I2C 64
alan1974 7:fba1e8fc7693 24 #define I2C_MIN_WAIT_DELAY 200 //minimum time between rcv/xmit i2c data and pulsing wake
alan1974 0:a91cd1b08360 25 #define I2C_ACK_PROC 0xff //first byte of i2c ack msg back to proc
alan1974 7:fba1e8fc7693 26 #define I2C_MAX_ACK_DATA 32 //max data bytes accepted from Rx downstream pkt
alan1974 1:0d25d9ddbe9f 27
alan1974 0:a91cd1b08360 28 //cmds to xdot
alan1974 0:a91cd1b08360 29 enum{
alan1974 0:a91cd1b08360 30 XDOT_CMD_XMIT_PKT = 1, //transmit data
alan1974 1:0d25d9ddbe9f 31 XDOT_CMD_GET_EUI, //get xdot EUI
alan1974 0:a91cd1b08360 32 XDOT_CMD_SET_KEY_X, //set one of the security keys
alan1974 0:a91cd1b08360 33 XDOT_CMD_GOTO_SLEEP, //go to sleep
alan1974 0:a91cd1b08360 34 XDOT_CMD_GATEWAY_PING, //ping gateway for RSSI
alan1974 1:0d25d9ddbe9f 35 XDOT_CMD_SET_NTWKSESS, //write/read network session to/from flash
alan1974 1:0d25d9ddbe9f 36 XDOT_CMD_SET_RADIO, //set's radio parameters
alan1974 9:cc23b2049639 37 XDOT_CMD_NVM, // xdot nvm memory
alan1974 0:a91cd1b08360 38 XDOT_CMD_UNDEFINED, //last cmd, not used
alan1974 0:a91cd1b08360 39 };
alan1974 0:a91cd1b08360 40
alan1974 0:a91cd1b08360 41
alan1974 0:a91cd1b08360 42 enum I2C_XFR_TYPE{
alan1974 0:a91cd1b08360 43 I2C_READ =0,
alan1974 0:a91cd1b08360 44 I2C_WRITE};
alan1974 0:a91cd1b08360 45
alan1974 0:a91cd1b08360 46 //structure: upstream pkt for xdot to transmit
alan1974 0:a91cd1b08360 47 //txData bfr: is located in the struc immediately after dataLen parameter
alan1974 1:0d25d9ddbe9f 48 // : this allows extending pkt_upstrm struc as new control parameters are needed
alan1974 0:a91cd1b08360 49 #define PKT_UPSTRM_RSVD (BUFFER_SIZE_I2C- (I2C_MAX_ACK_DATA + 7))
alan1974 0:a91cd1b08360 50 typedef struct {
alan1974 0:a91cd1b08360 51 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 52 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 53 uint8_t txData[I2C_MAX_ACK_DATA]; //array for tx Data
alan1974 0:a91cd1b08360 54 uint8_t joinAttemps; //max attempts to join network before quitting
alan1974 1:0d25d9ddbe9f 55 uint8_t appPort; //set app port (rev 0307)
alan1974 6:b2039a285d7f 56 uint8_t linkThreshCnt; //set link threshold count, 0 == disable
alan1974 1:0d25d9ddbe9f 57 uint8_t bSetAdr; //not used
alan1974 0:a91cd1b08360 58 uint8_t rxvd[PKT_UPSTRM_RSVD]; //rserved filler bytes
alan1974 0:a91cd1b08360 59 uint8_t chksum; //chksum of all previous, last byte in pkt
alan1974 0:a91cd1b08360 60 }pkt_upstrm;
alan1974 0:a91cd1b08360 61 //structure: results returned to proc of upstream data transmit
alan1974 0:a91cd1b08360 62 typedef struct {
alan1974 0:a91cd1b08360 63 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 64 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 65 uint8_t dataLen; //datalen found in pkt
alan1974 7:fba1e8fc7693 66 uint8_t bXmitAttempted; //true if xmit attempted, (fail of pkt len too big)
alan1974 0:a91cd1b08360 67 uint8_t joinAttempts; //# of join attempts before join occured, if bJoined=0 this = max attempts
alan1974 0:a91cd1b08360 68 uint8_t bJoined; //true if successfully joined
alan1974 0:a91cd1b08360 69 uint8_t bAck; //true if ack return from xmit
alan1974 0:a91cd1b08360 70 uint8_t bRx1; //true if rx1 return
alan1974 0:a91cd1b08360 71 uint8_t bAckdata; //true if rx data
alan1974 0:a91cd1b08360 72 int8_t rssi; //last rssi, 0 if no rx1/2 ack
alan1974 0:a91cd1b08360 73 uint8_t rxLen; //length of returned rxdata
alan1974 0:a91cd1b08360 74 uint8_t rxData[I2C_MAX_ACK_DATA]; //array for rx Data
alan1974 0:a91cd1b08360 75 int16_t mdot_ret; //mdot return code after calling send function
alan1974 0:a91cd1b08360 76 uint8_t chksum_err; //1 if chksum err on proc upstream pkt
alan1974 7:fba1e8fc7693 77 int8_t snr; //last snr, 0 if no rx1/2 ack
alan1974 7:fba1e8fc7693 78 uint8_t rsvd[15]; //reserved for future use
alan1974 0:a91cd1b08360 79 }pkt_ack;
alan1974 0:a91cd1b08360 80 //structure: results returned to proc for eui and api_level
alan1974 0:a91cd1b08360 81 //v0307: eui pkt now used to read/set radio params also
alan1974 0:a91cd1b08360 82 typedef struct {
alan1974 0:a91cd1b08360 83 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 84 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 85 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 86 uint8_t euiData[16]; //eui
alan1974 0:a91cd1b08360 87 uint8_t apiLvlData[4]; //api level
alan1974 0:a91cd1b08360 88 uint8_t verLvlData[4]; //ver level
alan1974 0:a91cd1b08360 89 }pkt_eui;
alan1974 9:cc23b2049639 90 //--------------------------------------------------------------------------
alan1974 0:a91cd1b08360 91 //structure: cmd structure to proc for setting radio parameters
alan1974 0:a91cd1b08360 92 //upstream pkt struc
alan1974 0:a91cd1b08360 93 typedef struct {
alan1974 0:a91cd1b08360 94 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 95 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 96 bool bSetParams; //if true then set and save variable params to nvm; false=> read params
alan1974 2:0af50f386eb2 97 xdot_radio_params params;
alan1974 0:a91cd1b08360 98 }pkt_setradioup;
alan1974 0:a91cd1b08360 99
alan1974 0:a91cd1b08360 100 //downstream pkt struc
alan1974 0:a91cd1b08360 101 //structure: cmd structure to proc for setting radio parameters
alan1974 0:a91cd1b08360 102 typedef struct {
alan1974 0:a91cd1b08360 103 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 104 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 105 uint8_t dataLen; //datalen found in pkt
alan1974 2:0af50f386eb2 106 xdot_radio_params params;
alan1974 0:a91cd1b08360 107 }pkt_setradiodwn;
alan1974 9:cc23b2049639 108 //--------------------------------------------------------------------------
alan1974 1:0d25d9ddbe9f 109 //nvm ptks
alan1974 9:cc23b2049639 110 enum {
alan1974 9:cc23b2049639 111 XDOT_NVM__READ = 0,
alan1974 9:cc23b2049639 112 XDOT_NVM_SET = 1,
alan1974 9:cc23b2049639 113 XDOT_NVM_RESTORE = 2,
alan1974 9:cc23b2049639 114 };
alan1974 1:0d25d9ddbe9f 115 //structure: cmd structure to proc for setting nvm parameters
alan1974 1:0d25d9ddbe9f 116 //upstream pkt struc
alan1974 1:0d25d9ddbe9f 117 typedef struct {
alan1974 1:0d25d9ddbe9f 118 uint8_t cmd; //cmd received from proc
alan1974 1:0d25d9ddbe9f 119 uint8_t dataLen; //datalen found in pkt
alan1974 9:cc23b2049639 120 uint8_t nvm_option; //read,write,restore
alan1974 1:0d25d9ddbe9f 121 nvm nvmData;
alan1974 1:0d25d9ddbe9f 122 }pkt_setnvmup;
alan1974 1:0d25d9ddbe9f 123 //dwnstream pkt struc
alan1974 1:0d25d9ddbe9f 124 typedef struct {
alan1974 1:0d25d9ddbe9f 125 uint8_t ack; //ack header response
alan1974 5:abfe25f0de33 126 uint8_t cmd; //cmd received from proc
alan1974 1:0d25d9ddbe9f 127 uint8_t dataLen; //datalen found in pkt
alan1974 5:abfe25f0de33 128 uint8_t bChkSumOK;
alan1974 1:0d25d9ddbe9f 129 nvm nvmData;
alan1974 1:0d25d9ddbe9f 130 }pkt_setnvmdwn;
alan1974 1:0d25d9ddbe9f 131
alan1974 9:cc23b2049639 132 //--------------------------------------------------------------------------
alan1974 1:0d25d9ddbe9f 133
alan1974 1:0d25d9ddbe9f 134
alan1974 1:0d25d9ddbe9f 135 //structure: results returned to proc network session
alan1974 1:0d25d9ddbe9f 136 typedef struct {
alan1974 1:0d25d9ddbe9f 137 uint8_t ack; //ack header response
alan1974 1:0d25d9ddbe9f 138 uint8_t cmd; //cmd received from proc
alan1974 1:0d25d9ddbe9f 139 uint8_t dataLen; //datalen found in pkt
alan1974 1:0d25d9ddbe9f 140 uint8_t bSetNetwrk; //1 if wrote network session, 0 if read
alan1974 1:0d25d9ddbe9f 141 }pkt_ntwrk;
alan1974 0:a91cd1b08360 142
alan1974 0:a91cd1b08360 143 //structure: results returned to proc of gateway ping
alan1974 0:a91cd1b08360 144 typedef struct {
alan1974 0:a91cd1b08360 145 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 146 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 147 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 148 int8_t status; //ping status return, 0 = success
alan1974 0:a91cd1b08360 149 int8_t rssi; //rssi that gateway heard from node
alan1974 0:a91cd1b08360 150 int8_t snr; //snr that ....
alan1974 0:a91cd1b08360 151 }pkt_ping;
alan1974 0:a91cd1b08360 152
alan1974 0:a91cd1b08360 153
alan1974 0:a91cd1b08360 154
alan1974 0:a91cd1b08360 155
alan1974 0:a91cd1b08360 156 typedef struct {
alan1974 0:a91cd1b08360 157 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 158 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 159 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 160 uint8_t rxData[I2C_MAX_ACK_DATA]; //Data
alan1974 0:a91cd1b08360 161 }data_ack;
alan1974 0:a91cd1b08360 162
alan1974 0:a91cd1b08360 163
alan1974 0:a91cd1b08360 164 void i2c_proc_init();
alan1974 0:a91cd1b08360 165 void i2c_wait4wake_lo(void);
alan1974 0:a91cd1b08360 166 void i2c_pulse_wake(void);
alan1974 0:a91cd1b08360 167 I2C_XFR_TYPE i2c_proc_comm();
alan1974 0:a91cd1b08360 168
alan1974 0:a91cd1b08360 169 #endif