Steen Jørgensen / MCP4261

8-Bit Single/Dual SPI Digital POT with Non-Volatile Memory

Fork of MCP4261 by TeamElectronics

MCP4261.cpp@1:935321af7311, 2015-06-28 (annotated)

Committer:
stjo2809
Date:
Sun Jun 28 10:24:49 2015 +0000
Revision:
1:935321af7311
Parent:
0:ff10d457fef2
Child:
2:1e4469bdbed9
v.1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
stjo2809 0:ff10d457fef2 1 /* mbed MCP4261 Library, for driving the 8-Bit Single/Dual SPI Digital POT with Non-Volatile Memory
stjo2809 0:ff10d457fef2 2 * Copyright (c) 2015, Created by Steen Joergensen (stjo2809)
stjo2809 0:ff10d457fef2 3 *
stjo2809 0:ff10d457fef2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
stjo2809 0:ff10d457fef2 5 * of this software and associated documentation files (the "Software"), to deal
stjo2809 0:ff10d457fef2 6 * in the Software without restriction, including without limitation the rights
stjo2809 0:ff10d457fef2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
stjo2809 0:ff10d457fef2 8 * copies of the Software, and to permit persons to whom the Software is
stjo2809 0:ff10d457fef2 9 * furnished to do so, subject to the following conditions:
stjo2809 0:ff10d457fef2 10 *
stjo2809 0:ff10d457fef2 11 * The above copyright notice and this permission notice shall be included in
stjo2809 0:ff10d457fef2 12 * all copies or substantial portions of the Software.
stjo2809 0:ff10d457fef2 13 *
stjo2809 0:ff10d457fef2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
stjo2809 0:ff10d457fef2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
stjo2809 0:ff10d457fef2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
stjo2809 0:ff10d457fef2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
stjo2809 0:ff10d457fef2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
stjo2809 0:ff10d457fef2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
stjo2809 0:ff10d457fef2 20 * THE SOFTWARE.
stjo2809 0:ff10d457fef2 21 */
stjo2809 0:ff10d457fef2 22
stjo2809 0:ff10d457fef2 23 #include "mbed.h"
stjo2809 0:ff10d457fef2 24 #include "MCP4261.h"
stjo2809 0:ff10d457fef2 25
stjo2809 0:ff10d457fef2 26 //=============================================================================
stjo2809 0:ff10d457fef2 27 // Public functions
stjo2809 0:ff10d457fef2 28 //=============================================================================
stjo2809 0:ff10d457fef2 29
stjo2809 1:935321af7311 30 MCP4261::MCP4261(SPI& spi, PinName nCs, PinName nWP, PinName nSHDN): _spi(spi), _nCs(nCs), _nWP(nWP), _nSHDN(nSHDN)
stjo2809 0:ff10d457fef2 31 {
stjo2809 0:ff10d457fef2 32
stjo2809 0:ff10d457fef2 33 }
stjo2809 0:ff10d457fef2 34
stjo2809 1:935321af7311 35 MCP4261::MCP4261(PinName mosi, PinName miso, PinName sck, PinName nCs, PinName nWP, PinName nSHDN) : _spi(mosi, miso, sck), _nCs(nCs), _nWP(nWP), _nSHDN(nSHDN)
stjo2809 0:ff10d457fef2 36 {
stjo2809 0:ff10d457fef2 37
stjo2809 0:ff10d457fef2 38 }
stjo2809 1:935321af7311 39
stjo2809 1:935321af7311 40 MCP4261::MCP4261(SPI& spi, PinName nCs, PinName nWP): _spi(spi), _nCs(nCs), _nWP(nWP)
stjo2809 1:935321af7311 41 {
stjo2809 1:935321af7311 42
stjo2809 1:935321af7311 43 }
stjo2809 1:935321af7311 44
stjo2809 0:ff10d457fef2 45 int MCP4261::read(char address)
stjo2809 0:ff10d457fef2 46 {
stjo2809 0:ff10d457fef2 47 _read(char address);
stjo2809 0:ff10d457fef2 48 }
stjo2809 0:ff10d457fef2 49
stjo2809 0:ff10d457fef2 50
stjo2809 0:ff10d457fef2 51 void MCP4261::write(char address, int data)
stjo2809 0:ff10d457fef2 52 {
stjo2809 0:ff10d457fef2 53 _write(char address, int data);
stjo2809 0:ff10d457fef2 54 }
stjo2809 0:ff10d457fef2 55
stjo2809 0:ff10d457fef2 56 void MCP4261::inc(bool number)
stjo2809 0:ff10d457fef2 57 {
stjo2809 0:ff10d457fef2 58 if(number == '0')
stjo2809 0:ff10d457fef2 59 {
stjo2809 0:ff10d457fef2 60 _make_command_byte(CB_INCR, VW0_ADDR, 0);
stjo2809 0:ff10d457fef2 61 _nCs = 0;
stjo2809 0:ff10d457fef2 62 _spi.write(_command_byte);
stjo2809 0:ff10d457fef2 63 _nCs = 1;
stjo2809 0:ff10d457fef2 64 }
stjo2809 0:ff10d457fef2 65 else
stjo2809 0:ff10d457fef2 66 {
stjo2809 0:ff10d457fef2 67 _make_command_byte(CB_INCR, VW1_ADDR, 0);
stjo2809 0:ff10d457fef2 68 _nCs = 0;
stjo2809 0:ff10d457fef2 69 _spi.write(_command_byte);
stjo2809 0:ff10d457fef2 70 _nCs = 1;
stjo2809 0:ff10d457fef2 71 }
stjo2809 0:ff10d457fef2 72 }
stjo2809 0:ff10d457fef2 73
stjo2809 0:ff10d457fef2 74 void MCP4261::dec(bool number)
stjo2809 0:ff10d457fef2 75 {
stjo2809 0:ff10d457fef2 76 if(number == '0')
stjo2809 0:ff10d457fef2 77 {
stjo2809 0:ff10d457fef2 78 _make_command_byte(CB_DECR, VW0_ADDR, 0);
stjo2809 0:ff10d457fef2 79 _nCs = 0;
stjo2809 0:ff10d457fef2 80 _spi.write(_command_byte);
stjo2809 0:ff10d457fef2 81 _nCs = 1;
stjo2809 0:ff10d457fef2 82 }
stjo2809 0:ff10d457fef2 83 else
stjo2809 0:ff10d457fef2 84 {
stjo2809 0:ff10d457fef2 85 _make_command_byte(CB_DECR, VW1_ADDR, 0);
stjo2809 0:ff10d457fef2 86 _nCs = 0;
stjo2809 0:ff10d457fef2 87 _spi.write(_command_byte);
stjo2809 0:ff10d457fef2 88 _nCs = 1;
stjo2809 0:ff10d457fef2 89 }
stjo2809 0:ff10d457fef2 90 }
stjo2809 0:ff10d457fef2 91
stjo2809 0:ff10d457fef2 92
stjo2809 0:ff10d457fef2 93 int MCP4261::status()
stjo2809 0:ff10d457fef2 94 {
stjo2809 0:ff10d457fef2 95 _read(STATUS_ADDR);
stjo2809 0:ff10d457fef2 96 }
stjo2809 0:ff10d457fef2 97
stjo2809 0:ff10d457fef2 98
stjo2809 0:ff10d457fef2 99 int MCP4261::tcon()
stjo2809 0:ff10d457fef2 100 {
stjo2809 0:ff10d457fef2 101 _read(TCON_ADDR);
stjo2809 0:ff10d457fef2 102 }
stjo2809 0:ff10d457fef2 103
stjo2809 0:ff10d457fef2 104
stjo2809 0:ff10d457fef2 105 void MCP4261::tcon(int data)
stjo2809 0:ff10d457fef2 106 {
stjo2809 0:ff10d457fef2 107 _write(TCON_ADDR, int data);
stjo2809 0:ff10d457fef2 108 }
stjo2809 0:ff10d457fef2 109
stjo2809 0:ff10d457fef2 110
stjo2809 0:ff10d457fef2 111 int MCP4261::wiper(bool number)
stjo2809 0:ff10d457fef2 112 {
stjo2809 0:ff10d457fef2 113 if(number == '0')
stjo2809 0:ff10d457fef2 114 {
stjo2809 0:ff10d457fef2 115 _read(VW0_ADDR);
stjo2809 0:ff10d457fef2 116 }
stjo2809 0:ff10d457fef2 117 else
stjo2809 0:ff10d457fef2 118 {
stjo2809 0:ff10d457fef2 119 _read(VW1_ADDR);
stjo2809 0:ff10d457fef2 120 }
stjo2809 0:ff10d457fef2 121 }
stjo2809 0:ff10d457fef2 122
stjo2809 0:ff10d457fef2 123
stjo2809 0:ff10d457fef2 124 void MCP4261::wiper(bool number, int data)
stjo2809 0:ff10d457fef2 125 {
stjo2809 0:ff10d457fef2 126 if(number == '0')
stjo2809 0:ff10d457fef2 127 {
stjo2809 0:ff10d457fef2 128 _write(VW0_ADDR, int data);
stjo2809 0:ff10d457fef2 129 }
stjo2809 0:ff10d457fef2 130 else
stjo2809 0:ff10d457fef2 131 {
stjo2809 0:ff10d457fef2 132 _write(VW1_ADDR, int data);
stjo2809 0:ff10d457fef2 133 }
stjo2809 0:ff10d457fef2 134 }
stjo2809 0:ff10d457fef2 135
stjo2809 0:ff10d457fef2 136
stjo2809 0:ff10d457fef2 137 int MCP4261::nvwiper(bool number)
stjo2809 0:ff10d457fef2 138 {
stjo2809 0:ff10d457fef2 139 if(number == '0')
stjo2809 0:ff10d457fef2 140 {
stjo2809 0:ff10d457fef2 141 _read(NVW0_ADDR);
stjo2809 0:ff10d457fef2 142 }
stjo2809 0:ff10d457fef2 143 else
stjo2809 0:ff10d457fef2 144 {
stjo2809 0:ff10d457fef2 145 _read(NVW1_ADDR);
stjo2809 0:ff10d457fef2 146 }
stjo2809 0:ff10d457fef2 147 }
stjo2809 0:ff10d457fef2 148
stjo2809 0:ff10d457fef2 149
stjo2809 0:ff10d457fef2 150 void MCP4261::nvwiper(bool number, int data)
stjo2809 0:ff10d457fef2 151 {
stjo2809 0:ff10d457fef2 152 if(number == '0')
stjo2809 0:ff10d457fef2 153 {
stjo2809 0:ff10d457fef2 154 _write(NVW0_ADDR, int data);
stjo2809 0:ff10d457fef2 155 }
stjo2809 0:ff10d457fef2 156 else
stjo2809 0:ff10d457fef2 157 {
stjo2809 0:ff10d457fef2 158 _write(NVW1_ADDR, int data);
stjo2809 0:ff10d457fef2 159 }
stjo2809 0:ff10d457fef2 160 }
stjo2809 0:ff10d457fef2 161
stjo2809 0:ff10d457fef2 162
stjo2809 0:ff10d457fef2 163 void MCP4261::shdn(bool act)
stjo2809 0:ff10d457fef2 164 {
stjo2809 0:ff10d457fef2 165 _nSHDN = ~act;
stjo2809 0:ff10d457fef2 166 }
stjo2809 0:ff10d457fef2 167
stjo2809 0:ff10d457fef2 168
stjo2809 0:ff10d457fef2 169 void MCP4261::wp(bool act)
stjo2809 0:ff10d457fef2 170 {
stjo2809 0:ff10d457fef2 171 _nWP = ~act;
stjo2809 0:ff10d457fef2 172 }
stjo2809 0:ff10d457fef2 173
stjo2809 0:ff10d457fef2 174 //=============================================================================
stjo2809 0:ff10d457fef2 175 // Private functions
stjo2809 0:ff10d457fef2 176 //=============================================================================
stjo2809 0:ff10d457fef2 177
stjo2809 0:ff10d457fef2 178 char MCP4261::_make_command_byte(int com, char address, int data)
stjo2809 0:ff10d457fef2 179 {
stjo2809 0:ff10d457fef2 180 if(data > 0xff && data < 0x3FF)
stjo2809 0:ff10d457fef2 181 {
stjo2809 0:ff10d457fef2 182 _command_byte = address << 4; // add address to _commad_byte
stjo2809 0:ff10d457fef2 183 _command_byte = _command_byte | (data >> 8); // add data to _commad_byte
stjo2809 0:ff10d457fef2 184 _command_byte = _command_byte | (com << 2); // add com to _commad_byte
stjo2809 0:ff10d457fef2 185 }
stjo2809 0:ff10d457fef2 186 else
stjo2809 0:ff10d457fef2 187 {
stjo2809 0:ff10d457fef2 188 _command_byte = address << 4; // add address to _commad_byte
stjo2809 0:ff10d457fef2 189 _command_byte = _command_byte | (com << 2); // add com to _commad_byte
stjo2809 0:ff10d457fef2 190 }
stjo2809 0:ff10d457fef2 191 }
stjo2809 0:ff10d457fef2 192
stjo2809 0:ff10d457fef2 193 int MCP4261::_read(char address)
stjo2809 0:ff10d457fef2 194 {
stjo2809 0:ff10d457fef2 195 int _response_msb;
stjo2809 0:ff10d457fef2 196 int _response_lsb;
stjo2809 0:ff10d457fef2 197 int _response;
stjo2809 0:ff10d457fef2 198
stjo2809 0:ff10d457fef2 199 _response = 0; // clear _response for old data
stjo2809 0:ff10d457fef2 200 _response_msb = 0; // clear _response_msb for old data
stjo2809 0:ff10d457fef2 201 _response_lsb = 0; // clear _response_lsb for old data
stjo2809 0:ff10d457fef2 202
stjo2809 0:ff10d457fef2 203 _make_command_byte(CB_READ, address, 0);
stjo2809 0:ff10d457fef2 204
stjo2809 0:ff10d457fef2 205 _nCs = 0;
stjo2809 0:ff10d457fef2 206 _spi.write(_command_byte);
stjo2809 0:ff10d457fef2 207 _spi.write(0xff); // not important bit of the 16 bits
stjo2809 0:ff10d457fef2 208 _response_msb = _spi.write(); // get response
stjo2809 0:ff10d457fef2 209 _response_lsb = _spi.write(); // get response
stjo2809 0:ff10d457fef2 210 _nCs = 1;
stjo2809 0:ff10d457fef2 211
stjo2809 0:ff10d457fef2 212 _response = _response_msb << 8;
stjo2809 0:ff10d457fef2 213 _response = _response | _response_lsb;
stjo2809 0:ff10d457fef2 214
stjo2809 0:ff10d457fef2 215 return _response;
stjo2809 0:ff10d457fef2 216 }
stjo2809 0:ff10d457fef2 217
stjo2809 0:ff10d457fef2 218 void MCP4261::_write(char address, int data)
stjo2809 0:ff10d457fef2 219 {
stjo2809 0:ff10d457fef2 220 _make_command_byte(CB_WRITE, address, data);
stjo2809 0:ff10d457fef2 221 int _send_data = data & 0xff;
stjo2809 0:ff10d457fef2 222
stjo2809 0:ff10d457fef2 223 _nCs = 0;
stjo2809 0:ff10d457fef2 224 _spi.write(_command_byte);
stjo2809 0:ff10d457fef2 225 _spi.write(_send_data);
stjo2809 0:ff10d457fef2 226 _nCs = 1;
stjo2809 0:ff10d457fef2 227 }
stjo2809 0:ff10d457fef2 228
stjo2809 0:ff10d457fef2 229
stjo2809 1:935321af7311 230
stjo2809 1:935321af7311 231