Maxim Integrated / max14661

library for MAX14661 16:2 mux

Dependents:   ard2pmod MAX14661_Demo

MAX14661 Component Page

max14661.cpp@2:88c168ddc145, 2014-11-19 (annotated)

Committer:
j3
Date:
Wed Nov 19 00:56:18 2014 +0000
Revision:
2:88c168ddc145
Parent:
1:c1fdfe4c2354
Child:
4:45fa0192f66d
Updated Max14661 class to inherit I2C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 0:c770ad7363c8 1 /******************************************************************//**
j3 0:c770ad7363c8 2 * @file max14661.cpp
j3 0:c770ad7363c8 3 *
j3 0:c770ad7363c8 4 * @author Justin Jordan
j3 0:c770ad7363c8 5 *
j3 0:c770ad7363c8 6 * @version 0.0
j3 0:c770ad7363c8 7 *
j3 0:c770ad7363c8 8 * Started: 11NOV14
j3 0:c770ad7363c8 9 *
j3 0:c770ad7363c8 10 * Updated:
j3 0:c770ad7363c8 11 *
j3 0:c770ad7363c8 12 * @brief Source file for MAX14661 class
j3 0:c770ad7363c8 13 *
j3 0:c770ad7363c8 14 ***********************************************************************
j3 0:c770ad7363c8 15 *
j3 0:c770ad7363c8 16 * @copyright
j3 0:c770ad7363c8 17 * Copyright (C) 2013 Maxim Integrated Products, Inc., All Rights Reserved.
j3 0:c770ad7363c8 18 *
j3 0:c770ad7363c8 19 * Permission is hereby granted, free of charge, to any person obtaining a
j3 0:c770ad7363c8 20 * copy of this software and associated documentation files (the "Software"),
j3 0:c770ad7363c8 21 * to deal in the Software without restriction, including without limitation
j3 0:c770ad7363c8 22 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 0:c770ad7363c8 23 * and/or sell copies of the Software, and to permit persons to whom the
j3 0:c770ad7363c8 24 * Software is furnished to do so, subject to the following conditions:
j3 0:c770ad7363c8 25 *
j3 0:c770ad7363c8 26 * The above copyright notice and this permission notice shall be included
j3 0:c770ad7363c8 27 * in all copies or substantial portions of the Software.
j3 0:c770ad7363c8 28 *
j3 0:c770ad7363c8 29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 0:c770ad7363c8 30 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 0:c770ad7363c8 31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 0:c770ad7363c8 32 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 0:c770ad7363c8 33 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 0:c770ad7363c8 34 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 0:c770ad7363c8 35 * OTHER DEALINGS IN THE SOFTWARE.
j3 0:c770ad7363c8 36 *
j3 0:c770ad7363c8 37 * Except as contained in this notice, the name of Maxim Integrated
j3 0:c770ad7363c8 38 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 0:c770ad7363c8 39 * Products, Inc. Branding Policy.
j3 0:c770ad7363c8 40 *
j3 0:c770ad7363c8 41 * The mere transfer of this software does not imply any licenses
j3 0:c770ad7363c8 42 * of trade secrets, proprietary technology, copyrights, patents,
j3 0:c770ad7363c8 43 * trademarks, maskwork rights, or any other form of intellectual
j3 0:c770ad7363c8 44 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 0:c770ad7363c8 45 * ownership rights.
j3 0:c770ad7363c8 46 **********************************************************************/
j3 0:c770ad7363c8 47
j3 0:c770ad7363c8 48
j3 0:c770ad7363c8 49 #include "max14661.h"
j3 0:c770ad7363c8 50
j3 0:c770ad7363c8 51
j3 2:88c168ddc145 52 /**********************************************************//**
j3 2:88c168ddc145 53 * Constructor for Max14661 Class
j3 0:c770ad7363c8 54 *
j3 0:c770ad7363c8 55 * On Entry:
j3 2:88c168ddc145 56 * @param[in] sda - sda pin of I2C bus
j3 2:88c168ddc145 57 * @param[in] scl - scl pin of I2C bus
j3 0:c770ad7363c8 58 * @param[in] i2c_adrs - 7-bit slave address of MAX14661
j3 0:c770ad7363c8 59 *
j3 0:c770ad7363c8 60 * On Exit:
j3 0:c770ad7363c8 61 * @return none
j3 0:c770ad7363c8 62 *
j3 0:c770ad7363c8 63 * Example:
j3 0:c770ad7363c8 64 * @code
j3 0:c770ad7363c8 65 *
j3 2:88c168ddc145 66 * //declare mux object
j3 2:88c168ddc145 67 * Max14661 mux(D14, D15, MAX14661_I2C_ADRS0);
j3 0:c770ad7363c8 68 *
j3 0:c770ad7363c8 69 * @endcode
j3 2:88c168ddc145 70 **************************************************************/
j3 2:88c168ddc145 71 Max14661::Max14661(PinName sda, PinName scl, max14661_i2c_adrs_t i2c_adrs) :
j3 2:88c168ddc145 72 I2C(sda, scl)
j3 0:c770ad7363c8 73 {
j3 0:c770ad7363c8 74 w_adrs = (i2c_adrs << 1);
j3 0:c770ad7363c8 75 r_adrs = (w_adrs | 0x01);
j3 0:c770ad7363c8 76 }
j3 0:c770ad7363c8 77
j3 0:c770ad7363c8 78
j3 0:c770ad7363c8 79 /******************************************************************//**
j3 0:c770ad7363c8 80 * Writes given commands to CMD_A and CMD_B
j3 0:c770ad7363c8 81 *
j3 0:c770ad7363c8 82 * On Entry:
j3 0:c770ad7363c8 83 * @param[in] cmdA - command for CMD_A
j3 0:c770ad7363c8 84 * @param[in] cmdB - command for CMD_B
j3 0:c770ad7363c8 85 *
j3 0:c770ad7363c8 86 * On Exit:
j3 0:c770ad7363c8 87 * @return return value = 0 on success, non-0 on failure
j3 0:c770ad7363c8 88 *
j3 0:c770ad7363c8 89 * Example:
j3 0:c770ad7363c8 90 * @code
j3 0:c770ad7363c8 91 *
j3 2:88c168ddc145 92 * //declare mux object
j3 2:88c168ddc145 93 * Max14661 mux(D14, D15, MAX14661_I2C_ADRS0);
j3 0:c770ad7363c8 94 *
j3 0:c770ad7363c8 95 * uint16_t rtn_val;
j3 0:c770ad7363c8 96 *
j3 0:c770ad7363c8 97 * rtn_val = mux.wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 0:c770ad7363c8 98 *
j3 0:c770ad7363c8 99 * @endcode
j3 0:c770ad7363c8 100 **********************************************************************/
j3 0:c770ad7363c8 101 uint16_t Max14661::wrt_cmd_registers(max14661_cmds_t cmdA,
j3 0:c770ad7363c8 102 max14661_cmds_t cmdB)
j3 0:c770ad7363c8 103 {
j3 0:c770ad7363c8 104 uint8_t data[3];
j3 0:c770ad7363c8 105 uint8_t data_length = 0;
j3 0:c770ad7363c8 106 uint16_t rtn_val = 1;
j3 0:c770ad7363c8 107
j3 0:c770ad7363c8 108 //build packet
j3 0:c770ad7363c8 109 data[data_length++] = CMD_A;
j3 0:c770ad7363c8 110 data[data_length++] = cmdA;
j3 0:c770ad7363c8 111 data[data_length++] = cmdB;
j3 0:c770ad7363c8 112
j3 2:88c168ddc145 113 rtn_val = write(w_adrs,(const char*) data, data_length);
j3 0:c770ad7363c8 114
j3 0:c770ad7363c8 115 return(rtn_val);
j3 0:c770ad7363c8 116 }
j3 0:c770ad7363c8 117
j3 0:c770ad7363c8 118
j3 0:c770ad7363c8 119 /******************************************************************//**
j3 0:c770ad7363c8 120 * Writes data pointed at by 'data' to shadow registers
j3 0:c770ad7363c8 121 *
j3 0:c770ad7363c8 122 * On Entry:
j3 0:c770ad7363c8 123 * @param[in] data - pointer to data
j3 0:c770ad7363c8 124 *
j3 0:c770ad7363c8 125 * On Exit:
j3 0:c770ad7363c8 126 * @return return value = 0 on success, non-0 on failure
j3 0:c770ad7363c8 127 *
j3 0:c770ad7363c8 128 * Example:
j3 0:c770ad7363c8 129 * @code
j3 0:c770ad7363c8 130 *
j3 2:88c168ddc145 131 * //declare mux object
j3 2:88c168ddc145 132 * Max14661 mux(D14, D15, MAX14661_I2C_ADRS0);
j3 0:c770ad7363c8 133 *
j3 0:c770ad7363c8 134 * uint8_t data[] = {1, 2, 3, 4};
j3 0:c770ad7363c8 135 * uint16_t rtn_val;
j3 0:c770ad7363c8 136 *
j3 0:c770ad7363c8 137 * //wite shadow registers
j3 0:c770ad7363c8 138 * rtn_val = mux.wrt_shadow_registers(data);
j3 0:c770ad7363c8 139 *
j3 0:c770ad7363c8 140 * @endcode
j3 0:c770ad7363c8 141 **********************************************************************/
j3 0:c770ad7363c8 142 uint16_t Max14661::wrt_shadow_registers(uint8_t* data)
j3 0:c770ad7363c8 143 {
j3 0:c770ad7363c8 144 uint8_t local_data[5];
j3 0:c770ad7363c8 145 uint8_t data_length = 0;
j3 0:c770ad7363c8 146 uint16_t rtn_val = 1;
j3 0:c770ad7363c8 147
j3 0:c770ad7363c8 148 local_data[data_length++] = SHDW0;
j3 0:c770ad7363c8 149
j3 0:c770ad7363c8 150 for(; data_length < 5; data_length++)
j3 0:c770ad7363c8 151 {
j3 0:c770ad7363c8 152 local_data[data_length] = data[data_length-1];
j3 0:c770ad7363c8 153 }
j3 0:c770ad7363c8 154
j3 2:88c168ddc145 155 rtn_val = write(w_adrs,(const char*) local_data, data_length);
j3 0:c770ad7363c8 156
j3 0:c770ad7363c8 157 return(rtn_val);
j3 0:c770ad7363c8 158 }
j3 0:c770ad7363c8 159
j3 0:c770ad7363c8 160
j3 0:c770ad7363c8 161 /******************************************************************//**
j3 0:c770ad7363c8 162 * Writes data pointed at by 'data' to direct access registers
j3 0:c770ad7363c8 163 *
j3 0:c770ad7363c8 164 * On Entry:
j3 0:c770ad7363c8 165 * @param[in] data - pointer to data to be written
j3 0:c770ad7363c8 166 *
j3 0:c770ad7363c8 167 * On Exit:
j3 0:c770ad7363c8 168 * @return return value = 0 on success, non-0 on failure
j3 0:c770ad7363c8 169 *
j3 0:c770ad7363c8 170 * Example:
j3 1:c1fdfe4c2354 171 * @code
j3 0:c770ad7363c8 172 *
j3 2:88c168ddc145 173 * //declare mux object
j3 2:88c168ddc145 174 * Max14661 mux(D14, D15, MAX14661_I2C_ADRS0);
j3 0:c770ad7363c8 175 *
j3 0:c770ad7363c8 176 * uint8_t data[] = {1, 2, 3, 4};
j3 0:c770ad7363c8 177 * uint16_t rtn_val;
j3 0:c770ad7363c8 178 *
j3 0:c770ad7363c8 179 * //wite shadow registers
j3 0:c770ad7363c8 180 * rtn_val = mux.wrt_shadow_registers(data);
j3 0:c770ad7363c8 181 *
j3 0:c770ad7363c8 182 * @endcode
j3 0:c770ad7363c8 183 **********************************************************************/
j3 0:c770ad7363c8 184 uint16_t Max14661::wrt_dir_registers(uint8_t* data)
j3 0:c770ad7363c8 185 {
j3 0:c770ad7363c8 186 uint8_t local_data[5];
j3 0:c770ad7363c8 187 uint8_t data_length = 0;
j3 0:c770ad7363c8 188 uint16_t rtn_val = 1;
j3 0:c770ad7363c8 189
j3 0:c770ad7363c8 190 local_data[data_length++] = DIR0;
j3 0:c770ad7363c8 191
j3 0:c770ad7363c8 192 for(; data_length < 5; data_length++)
j3 0:c770ad7363c8 193 {
j3 0:c770ad7363c8 194 local_data[data_length] = data[data_length-1];
j3 0:c770ad7363c8 195 }
j3 0:c770ad7363c8 196
j3 2:88c168ddc145 197 rtn_val = write(w_adrs,(const char*) local_data, data_length);
j3 0:c770ad7363c8 198
j3 0:c770ad7363c8 199 return(rtn_val);
j3 0:c770ad7363c8 200 }
j3 0:c770ad7363c8 201
j3 0:c770ad7363c8 202
j3 0:c770ad7363c8 203 /**********************************************************//**
j3 0:c770ad7363c8 204 * Reads data from direct access registers starting at DIR0 and
j3 0:c770ad7363c8 205 * stores it in byte array pointed at by 'data'
j3 0:c770ad7363c8 206 *
j3 0:c770ad7363c8 207 * On Entry:
j3 0:c770ad7363c8 208 * @param[in] data - pointer to byte array for storing data
j3 0:c770ad7363c8 209 *
j3 0:c770ad7363c8 210 * On Exit:
j3 0:c770ad7363c8 211 * @param[out] data - data buffer now contains data read
j3 0:c770ad7363c8 212 * from dir registers
j3 0:c770ad7363c8 213 * @return return value = 0 on success, non-0 on failure
j3 0:c770ad7363c8 214 *
j3 0:c770ad7363c8 215 * Example:
j3 0:c770ad7363c8 216 * @code
j3 0:c770ad7363c8 217 *
j3 2:88c168ddc145 218 * //declare mux object
j3 2:88c168ddc145 219 * Max14661 mux(D14, D15, MAX14661_I2C_ADRS0);
j3 0:c770ad7363c8 220 *
j3 0:c770ad7363c8 221 * uint16_t rtn_val;
j3 0:c770ad7363c8 222 * uint8_t data[4];
j3 0:c770ad7363c8 223 *
j3 0:c770ad7363c8 224 * //read direct access registers
j3 0:c770ad7363c8 225 * rtn_val = mux.rd_dir_registers(data);
j3 0:c770ad7363c8 226 *
j3 0:c770ad7363c8 227 * @endcode
j3 0:c770ad7363c8 228 **********************************************************************/
j3 0:c770ad7363c8 229 uint16_t Max14661::rd_dir_registers(uint8_t* data)
j3 0:c770ad7363c8 230 {
j3 0:c770ad7363c8 231 uint16_t rtn_val = 1;
j3 0:c770ad7363c8 232 uint8_t local_data = DIR0;
j3 0:c770ad7363c8 233
j3 2:88c168ddc145 234 rtn_val = write(w_adrs,(const char*) local_data, 1);
j3 0:c770ad7363c8 235
j3 0:c770ad7363c8 236 if(!rtn_val)
j3 0:c770ad7363c8 237 {
j3 2:88c168ddc145 238 rtn_val = read(r_adrs,(char*) data, 4);
j3 0:c770ad7363c8 239 }
j3 0:c770ad7363c8 240
j3 0:c770ad7363c8 241 return(rtn_val);
j3 0:c770ad7363c8 242 }
j3 0:c770ad7363c8 243
j3 0:c770ad7363c8 244
j3 0:c770ad7363c8 245 /**********************************************************//**
j3 0:c770ad7363c8 246 * Reads data from shadow registers starting at SHDW0 and stores
j3 0:c770ad7363c8 247 * it in byte array pointed at by 'data'
j3 0:c770ad7363c8 248 *
j3 0:c770ad7363c8 249 * On Entry:
j3 0:c770ad7363c8 250 * @param[in] data - pointer to byte array for storing data
j3 0:c770ad7363c8 251 *
j3 0:c770ad7363c8 252 * On Exit:
j3 0:c770ad7363c8 253 * @param[out] data - data buffer now contains data read
j3 0:c770ad7363c8 254 * from shadow registers
j3 0:c770ad7363c8 255 * @return return value = 0 on success, non-0 on failure
j3 0:c770ad7363c8 256 *
j3 0:c770ad7363c8 257 * Example:
j3 0:c770ad7363c8 258 * @code
j3 0:c770ad7363c8 259 *
j3 2:88c168ddc145 260 * //declare mux object
j3 2:88c168ddc145 261 * Max14661 mux(D14, D15, MAX14661_I2C_ADRS0);
j3 0:c770ad7363c8 262 *
j3 0:c770ad7363c8 263 * uint16_t rtn_val;
j3 0:c770ad7363c8 264 * uint8_t data[4];
j3 0:c770ad7363c8 265 *
j3 0:c770ad7363c8 266 * //read shadow registers
j3 0:c770ad7363c8 267 * rtn_val = mux.rd_shadow_registers(data);
j3 0:c770ad7363c8 268 *
j3 0:c770ad7363c8 269 * @endcode
j3 2:88c168ddc145 270 **************************************************************/
j3 0:c770ad7363c8 271 uint16_t Max14661::rd_shadow_registers(uint8_t* data)
j3 0:c770ad7363c8 272 {
j3 0:c770ad7363c8 273 uint16_t rtn_val = 1;
j3 0:c770ad7363c8 274 uint8_t local_data = SHDW0;
j3 0:c770ad7363c8 275
j3 2:88c168ddc145 276 rtn_val = write(w_adrs,(const char*) local_data, 1);
j3 0:c770ad7363c8 277
j3 0:c770ad7363c8 278 if(!rtn_val)
j3 0:c770ad7363c8 279 {
j3 2:88c168ddc145 280 rtn_val = read(r_adrs,(char*) data, 4);
j3 0:c770ad7363c8 281 }
j3 0:c770ad7363c8 282
j3 0:c770ad7363c8 283 return(rtn_val);
j3 0:c770ad7363c8 284 }