alan broad / Mbed OS carbon_v5_arm_studio

arm studio build

Dependencies:   libxDot-mbed5

inc/commI2C.h@14:fc836a5a5d2f, 2019-01-18 (annotated)

Committer:
alan1974
Date:
Fri Jan 18 18:15:29 2019 +0000
Revision:
14:fc836a5a5d2f
Parent:
12:7944e4dbe853
Child:
17:74d60177c6b6
upload of ABP credentials done

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 14:fc836a5a5d2f 32 XDOT_CMD_SET_KEY_X, //set one of the security keys -> not used ?
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 12:7944e4dbe853 38 XDOT_CMD_NVM_ABP, // xdot nvm for multicast ABP creds
alan1974 14:fc836a5a5d2f 39 XDOT_CMD_SET_RADIO_CLASS, // change radio class to A or C
alan1974 0:a91cd1b08360 40 XDOT_CMD_UNDEFINED, //last cmd, not used
alan1974 0:a91cd1b08360 41 };
alan1974 0:a91cd1b08360 42
alan1974 0:a91cd1b08360 43
alan1974 0:a91cd1b08360 44 enum I2C_XFR_TYPE{
alan1974 0:a91cd1b08360 45 I2C_READ =0,
alan1974 0:a91cd1b08360 46 I2C_WRITE};
alan1974 0:a91cd1b08360 47
alan1974 0:a91cd1b08360 48 //structure: upstream pkt for xdot to transmit
alan1974 0:a91cd1b08360 49 //txData bfr: is located in the struc immediately after dataLen parameter
alan1974 1:0d25d9ddbe9f 50 // : this allows extending pkt_upstrm struc as new control parameters are needed
alan1974 0:a91cd1b08360 51 #define PKT_UPSTRM_RSVD (BUFFER_SIZE_I2C- (I2C_MAX_ACK_DATA + 7))
alan1974 0:a91cd1b08360 52 typedef struct {
alan1974 0:a91cd1b08360 53 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 54 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 55 uint8_t txData[I2C_MAX_ACK_DATA]; //array for tx Data
alan1974 0:a91cd1b08360 56 uint8_t joinAttemps; //max attempts to join network before quitting
alan1974 1:0d25d9ddbe9f 57 uint8_t appPort; //set app port (rev 0307)
alan1974 6:b2039a285d7f 58 uint8_t linkThreshCnt; //set link threshold count, 0 == disable
alan1974 1:0d25d9ddbe9f 59 uint8_t bSetAdr; //not used
alan1974 0:a91cd1b08360 60 uint8_t rxvd[PKT_UPSTRM_RSVD]; //rserved filler bytes
alan1974 0:a91cd1b08360 61 uint8_t chksum; //chksum of all previous, last byte in pkt
alan1974 0:a91cd1b08360 62 }pkt_upstrm;
alan1974 0:a91cd1b08360 63 //structure: results returned to proc of upstream data transmit
alan1974 0:a91cd1b08360 64 typedef struct {
alan1974 0:a91cd1b08360 65 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 66 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 67 uint8_t dataLen; //datalen found in pkt
alan1974 7:fba1e8fc7693 68 uint8_t bXmitAttempted; //true if xmit attempted, (fail of pkt len too big)
alan1974 0:a91cd1b08360 69 uint8_t joinAttempts; //# of join attempts before join occured, if bJoined=0 this = max attempts
alan1974 0:a91cd1b08360 70 uint8_t bJoined; //true if successfully joined
alan1974 0:a91cd1b08360 71 uint8_t bAck; //true if ack return from xmit
alan1974 0:a91cd1b08360 72 uint8_t bRx1; //true if rx1 return
alan1974 0:a91cd1b08360 73 uint8_t bAckdata; //true if rx data
alan1974 0:a91cd1b08360 74 int8_t rssi; //last rssi, 0 if no rx1/2 ack
alan1974 0:a91cd1b08360 75 uint8_t rxLen; //length of returned rxdata
alan1974 0:a91cd1b08360 76 uint8_t rxData[I2C_MAX_ACK_DATA]; //array for rx Data
alan1974 0:a91cd1b08360 77 int16_t mdot_ret; //mdot return code after calling send function
alan1974 0:a91cd1b08360 78 uint8_t chksum_err; //1 if chksum err on proc upstream pkt
alan1974 7:fba1e8fc7693 79 int8_t snr; //last snr, 0 if no rx1/2 ack
alan1974 12:7944e4dbe853 80 uint8_t appPort; //rcvd app port (rev 0309)
alan1974 12:7944e4dbe853 81 uint8_t rsvd[14]; //reserved for future use
alan1974 0:a91cd1b08360 82 }pkt_ack;
alan1974 0:a91cd1b08360 83 //structure: results returned to proc for eui and api_level
alan1974 0:a91cd1b08360 84 //v0307: eui pkt now used to read/set radio params also
alan1974 0:a91cd1b08360 85 typedef struct {
alan1974 0:a91cd1b08360 86 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 87 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 88 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 89 uint8_t euiData[16]; //eui
alan1974 0:a91cd1b08360 90 uint8_t apiLvlData[4]; //api level
alan1974 0:a91cd1b08360 91 uint8_t verLvlData[4]; //ver level
alan1974 0:a91cd1b08360 92 }pkt_eui;
alan1974 9:cc23b2049639 93 //--------------------------------------------------------------------------
alan1974 0:a91cd1b08360 94 //structure: cmd structure to proc for setting radio parameters
alan1974 0:a91cd1b08360 95 //upstream pkt struc
alan1974 0:a91cd1b08360 96 typedef struct {
alan1974 0:a91cd1b08360 97 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 98 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 99 bool bSetParams; //if true then set and save variable params to nvm; false=> read params
alan1974 2:0af50f386eb2 100 xdot_radio_params params;
alan1974 0:a91cd1b08360 101 }pkt_setradioup;
alan1974 0:a91cd1b08360 102
alan1974 0:a91cd1b08360 103 //downstream pkt struc
alan1974 0:a91cd1b08360 104 //structure: cmd structure to proc for setting radio parameters
alan1974 0:a91cd1b08360 105 typedef struct {
alan1974 0:a91cd1b08360 106 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 107 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 108 uint8_t dataLen; //datalen found in pkt
alan1974 2:0af50f386eb2 109 xdot_radio_params params;
alan1974 0:a91cd1b08360 110 }pkt_setradiodwn;
alan1974 9:cc23b2049639 111 //--------------------------------------------------------------------------
alan1974 12:7944e4dbe853 112 //nvm ptks for OTAA creds
alan1974 9:cc23b2049639 113 enum {
alan1974 9:cc23b2049639 114 XDOT_NVM__READ = 0,
alan1974 9:cc23b2049639 115 XDOT_NVM_SET = 1,
alan1974 9:cc23b2049639 116 XDOT_NVM_RESTORE = 2,
alan1974 9:cc23b2049639 117 };
alan1974 1:0d25d9ddbe9f 118 //structure: cmd structure to proc for setting nvm parameters
alan1974 1:0d25d9ddbe9f 119 //upstream pkt struc
alan1974 1:0d25d9ddbe9f 120 typedef struct {
alan1974 1:0d25d9ddbe9f 121 uint8_t cmd; //cmd received from proc
alan1974 1:0d25d9ddbe9f 122 uint8_t dataLen; //datalen found in pkt
alan1974 9:cc23b2049639 123 uint8_t nvm_option; //read,write,restore
alan1974 1:0d25d9ddbe9f 124 nvm nvmData;
alan1974 1:0d25d9ddbe9f 125 }pkt_setnvmup;
alan1974 1:0d25d9ddbe9f 126 //dwnstream pkt struc
alan1974 1:0d25d9ddbe9f 127 typedef struct {
alan1974 1:0d25d9ddbe9f 128 uint8_t ack; //ack header response
alan1974 5:abfe25f0de33 129 uint8_t cmd; //cmd received from proc
alan1974 1:0d25d9ddbe9f 130 uint8_t dataLen; //datalen found in pkt
alan1974 5:abfe25f0de33 131 uint8_t bChkSumOK;
alan1974 1:0d25d9ddbe9f 132 nvm nvmData;
alan1974 1:0d25d9ddbe9f 133 }pkt_setnvmdwn;
alan1974 12:7944e4dbe853 134 //--------------------------------------------------------------------------
alan1974 14:fc836a5a5d2f 135 //nvm ptks for ABP creds ---> REMOVE ???????????
alan1974 14:fc836a5a5d2f 136 //--------------------------------------------------------------------------
alan1974 12:7944e4dbe853 137 //upstream pkt struc
alan1974 12:7944e4dbe853 138 typedef struct {
alan1974 12:7944e4dbe853 139 uint8_t cmd; //cmd received from proc
alan1974 12:7944e4dbe853 140 uint8_t dataLen; //datalen found in pkt
alan1974 12:7944e4dbe853 141 uint8_t nvm_option; //read,write,restore
alan1974 12:7944e4dbe853 142 nvmABP nvmData;
alan1974 12:7944e4dbe853 143 }pkt_setnvmABPup;
alan1974 12:7944e4dbe853 144 //dwnstream pkt struc
alan1974 12:7944e4dbe853 145 typedef struct {
alan1974 12:7944e4dbe853 146 uint8_t ack; //ack header response
alan1974 12:7944e4dbe853 147 uint8_t cmd; //cmd received from proc
alan1974 12:7944e4dbe853 148 uint8_t dataLen; //datalen found in pkt
alan1974 12:7944e4dbe853 149 uint8_t bChkSumOK;
alan1974 12:7944e4dbe853 150 nvmABP nvmData;
alan1974 12:7944e4dbe853 151 }pkt_setnvmABPdwn;
alan1974 12:7944e4dbe853 152
alan1974 14:fc836a5a5d2f 153 //--------------------------------------------------------------------------
alan1974 14:fc836a5a5d2f 154 //ptks for class A/B radio change
alan1974 14:fc836a5a5d2f 155 //--------------------------------------------------------------------------
alan1974 14:fc836a5a5d2f 156 //upstream pkt struc
alan1974 14:fc836a5a5d2f 157 typedef struct {
alan1974 14:fc836a5a5d2f 158 uint8_t cmd; //cmd received from proc
alan1974 14:fc836a5a5d2f 159 uint8_t dataLen; //datalen found in pkt
alan1974 14:fc836a5a5d2f 160 class_switch classData;
alan1974 14:fc836a5a5d2f 161 }pkt_setClassUp;
alan1974 14:fc836a5a5d2f 162 //dwnstream pkt struc
alan1974 14:fc836a5a5d2f 163 typedef struct {
alan1974 14:fc836a5a5d2f 164 uint8_t ack; //ack header response
alan1974 14:fc836a5a5d2f 165 uint8_t cmd; //cmd received from proc
alan1974 14:fc836a5a5d2f 166 uint8_t dataLen; //datalen found in pkt
alan1974 14:fc836a5a5d2f 167 bool bSwitched; //1 = switched OK
alan1974 14:fc836a5a5d2f 168 }pkt_setClassDwn;
alan1974 12:7944e4dbe853 169
alan1974 12:7944e4dbe853 170
alan1974 1:0d25d9ddbe9f 171
alan1974 1:0d25d9ddbe9f 172
alan1974 1:0d25d9ddbe9f 173 //structure: results returned to proc network session
alan1974 1:0d25d9ddbe9f 174 typedef struct {
alan1974 1:0d25d9ddbe9f 175 uint8_t ack; //ack header response
alan1974 1:0d25d9ddbe9f 176 uint8_t cmd; //cmd received from proc
alan1974 1:0d25d9ddbe9f 177 uint8_t dataLen; //datalen found in pkt
alan1974 1:0d25d9ddbe9f 178 uint8_t bSetNetwrk; //1 if wrote network session, 0 if read
alan1974 1:0d25d9ddbe9f 179 }pkt_ntwrk;
alan1974 0:a91cd1b08360 180
alan1974 0:a91cd1b08360 181 //structure: results returned to proc of gateway ping
alan1974 0:a91cd1b08360 182 typedef struct {
alan1974 0:a91cd1b08360 183 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 184 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 185 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 186 int8_t status; //ping status return, 0 = success
alan1974 0:a91cd1b08360 187 int8_t rssi; //rssi that gateway heard from node
alan1974 0:a91cd1b08360 188 int8_t snr; //snr that ....
alan1974 0:a91cd1b08360 189 }pkt_ping;
alan1974 0:a91cd1b08360 190
alan1974 0:a91cd1b08360 191
alan1974 0:a91cd1b08360 192
alan1974 0:a91cd1b08360 193
alan1974 0:a91cd1b08360 194 typedef struct {
alan1974 0:a91cd1b08360 195 uint8_t ack; //ack header response
alan1974 0:a91cd1b08360 196 uint8_t cmd; //cmd received from proc
alan1974 0:a91cd1b08360 197 uint8_t dataLen; //datalen found in pkt
alan1974 0:a91cd1b08360 198 uint8_t rxData[I2C_MAX_ACK_DATA]; //Data
alan1974 0:a91cd1b08360 199 }data_ack;
alan1974 0:a91cd1b08360 200
alan1974 0:a91cd1b08360 201
alan1974 0:a91cd1b08360 202 void i2c_proc_init();
alan1974 0:a91cd1b08360 203 void i2c_wait4wake_lo(void);
alan1974 0:a91cd1b08360 204 void i2c_pulse_wake(void);
alan1974 0:a91cd1b08360 205 I2C_XFR_TYPE i2c_proc_comm();
alan1974 0:a91cd1b08360 206
alan1974 0:a91cd1b08360 207 #endif