kota sato / MCP320x

This is library for mcp320x. But operation check is not finished only "mcp3204".

Dependents:   Nucleo_mcp3204test

MCP320x.cpp@0:775667bb8069, 2016-01-29 (annotated)

Committer:
SK_ROBO_
Date:
Fri Jan 29 02:30:11 2016 +0000
Revision:
0:775667bb8069
Child:
1:66fdf46dc4de
first commit.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
SK_ROBO_ 0:775667bb8069 1 /* mbed simplified access to Microchip 12 bits ADC devices (SPI)
SK_ROBO_ 0:775667bb8069 2 * Copyright (c) 2013 ygarcia, MIT License
SK_ROBO_ 0:775667bb8069 3 *
SK_ROBO_ 0:775667bb8069 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
SK_ROBO_ 0:775667bb8069 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
SK_ROBO_ 0:775667bb8069 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
SK_ROBO_ 0:775667bb8069 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
SK_ROBO_ 0:775667bb8069 8 * furnished to do so, subject to the following conditions:
SK_ROBO_ 0:775667bb8069 9 *
SK_ROBO_ 0:775667bb8069 10 * The above copyright notice and this permission notice shall be included in all copies or
SK_ROBO_ 0:775667bb8069 11 * substantial portions of the Software.
SK_ROBO_ 0:775667bb8069 12 *
SK_ROBO_ 0:775667bb8069 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
SK_ROBO_ 0:775667bb8069 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
SK_ROBO_ 0:775667bb8069 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
SK_ROBO_ 0:775667bb8069 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
SK_ROBO_ 0:775667bb8069 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SK_ROBO_ 0:775667bb8069 18 */
SK_ROBO_ 0:775667bb8069 19
SK_ROBO_ 0:775667bb8069 20 #include "MCP320x.h"
SK_ROBO_ 0:775667bb8069 21
SK_ROBO_ 0:775667bb8069 22 namespace MCP320x_SPI {
SK_ROBO_ 0:775667bb8069 23
SK_ROBO_ 0:775667bb8069 24 unsigned char CMCP320x_SPI::SPIModuleRefCounter = 0;
SK_ROBO_ 0:775667bb8069 25
SK_ROBO_ 0:775667bb8069 26 CMCP320x_SPI::CMCP320x_SPI(const PinName p_mosi, const PinName p_miso, const PinName p_sclk, const PinName p_cs, const Mcp320xFamilly p_familly, const unsigned int p_frequency) : _internalId("") {
SK_ROBO_ 0:775667bb8069 27 DEBUG_ENTER("CMCP320x_SPI")
SK_ROBO_ 0:775667bb8069 28
SK_ROBO_ 0:775667bb8069 29 CMCP320x_SPI::SPIModuleRefCounter += 1;
SK_ROBO_ 0:775667bb8069 30 if (CMCP320x_SPI::SPIModuleRefCounter > 1) {
SK_ROBO_ 0:775667bb8069 31 //FIXME Check that SPI settings are identical. Otherwise it should failed
SK_ROBO_ 0:775667bb8069 32 return;
SK_ROBO_ 0:775667bb8069 33 }
SK_ROBO_ 0:775667bb8069 34
SK_ROBO_ 0:775667bb8069 35 _familly = p_familly;
SK_ROBO_ 0:775667bb8069 36 switch (_familly) {
SK_ROBO_ 0:775667bb8069 37 case _3201:
SK_ROBO_ 0:775667bb8069 38 _channelsNum = 1;
SK_ROBO_ 0:775667bb8069 39 break;
SK_ROBO_ 0:775667bb8069 40 case _3204:
SK_ROBO_ 0:775667bb8069 41 _channelsNum = 4;
SK_ROBO_ 0:775667bb8069 42 break;
SK_ROBO_ 0:775667bb8069 43 default: // _3208
SK_ROBO_ 0:775667bb8069 44 _channelsNum = 8;
SK_ROBO_ 0:775667bb8069 45 } // End of 'switch' statement
SK_ROBO_ 0:775667bb8069 46 _settings = 0x02; // SGL/DIFF bit set to 1 = See DS21298E-page 19 TABLE 5-1: CONFIGURATION BITS FOR THE MCP3204/TABLE 5-2: CONFIGURATION BITS FOR THE MCP3208
SK_ROBO_ 0:775667bb8069 47 DEBUG("CMCP320x_SPI: familly:%d - #channels:%d", _familly, _channelsNum)
SK_ROBO_ 0:775667bb8069 48 _spiInstance = new SPI(p_mosi, p_miso, p_sclk);
SK_ROBO_ 0:775667bb8069 49 _spiInstance->frequency(p_frequency); // Set the frequency of the SPI interface
SK_ROBO_ 0:775667bb8069 50 _spiInstance->format(8, 3);
SK_ROBO_ 0:775667bb8069 51 DEBUG_ENTER("CMCP320x_SPI: refCounter=%d", CMCP320x_SPI::SPIModuleRefCounter)
SK_ROBO_ 0:775667bb8069 52
SK_ROBO_ 0:775667bb8069 53 if (p_cs != NC) {
SK_ROBO_ 0:775667bb8069 54 DEBUG("CMCP320x_SPI: /CS managed");
SK_ROBO_ 0:775667bb8069 55 _cs = new DigitalOut(p_cs);
SK_ROBO_ 0:775667bb8069 56 _cs->write(1); // Disable chip
SK_ROBO_ 0:775667bb8069 57 } else {
SK_ROBO_ 0:775667bb8069 58 DEBUG("CMCP320x_SPI: /CS not managed");
SK_ROBO_ 0:775667bb8069 59 _cs = NULL; // Not used
SK_ROBO_ 0:775667bb8069 60 }
SK_ROBO_ 0:775667bb8069 61
SK_ROBO_ 0:775667bb8069 62
SK_ROBO_ 0:775667bb8069 63 DEBUG_LEAVE("CMCP320x_SPI")
SK_ROBO_ 0:775667bb8069 64 }
SK_ROBO_ 0:775667bb8069 65
SK_ROBO_ 0:775667bb8069 66 CMCP320x_SPI::~CMCP320x_SPI() {
SK_ROBO_ 0:775667bb8069 67 DEBUG_ENTER("~CMCP320x_SPI")
SK_ROBO_ 0:775667bb8069 68
SK_ROBO_ 0:775667bb8069 69 // Release I2C instance
SK_ROBO_ 0:775667bb8069 70 DEBUG_ENTER("~CMCP320x_SPI: refCounter=%d", CMCP320x_SPI::SPIModuleRefCounter)
SK_ROBO_ 0:775667bb8069 71 CMCP320x_SPI::SPIModuleRefCounter -= 1;
SK_ROBO_ 0:775667bb8069 72 if (CMCP320x_SPI::SPIModuleRefCounter == 0) {
SK_ROBO_ 0:775667bb8069 73 delete _spiInstance;
SK_ROBO_ 0:775667bb8069 74 _spiInstance = NULL;
SK_ROBO_ 0:775667bb8069 75 }
SK_ROBO_ 0:775667bb8069 76 // Release _reset if required
SK_ROBO_ 0:775667bb8069 77 if (_cs != NULL) {
SK_ROBO_ 0:775667bb8069 78 _cs->write(1);
SK_ROBO_ 0:775667bb8069 79 delete _cs;
SK_ROBO_ 0:775667bb8069 80 }
SK_ROBO_ 0:775667bb8069 81
SK_ROBO_ 0:775667bb8069 82 DEBUG_LEAVE("~CMCP320x_SPI")
SK_ROBO_ 0:775667bb8069 83 }
SK_ROBO_ 0:775667bb8069 84
SK_ROBO_ 0:775667bb8069 85 float CMCP320x_SPI::Read(const Mcp320xChannels p_channels) {
SK_ROBO_ 0:775667bb8069 86 DEBUG_ENTER("CMCP320x_SPI::Read: %d", (unsigned char)p_channels)
SK_ROBO_ 0:775667bb8069 87
SK_ROBO_ 0:775667bb8069 88 // Read a sample
SK_ROBO_ 0:775667bb8069 89 _sample.value = 0x00;
SK_ROBO_ 0:775667bb8069 90 switch (_familly) {
SK_ROBO_ 0:775667bb8069 91 case _3204:
SK_ROBO_ 0:775667bb8069 92 // No break;
SK_ROBO_ 0:775667bb8069 93 case _3208:
SK_ROBO_ 0:775667bb8069 94 Read_320x(p_channels);
SK_ROBO_ 0:775667bb8069 95 break;
SK_ROBO_ 0:775667bb8069 96 default: // _3201
SK_ROBO_ 0:775667bb8069 97 Read_3201();
SK_ROBO_ 0:775667bb8069 98 break;
SK_ROBO_ 0:775667bb8069 99 } // End of 'switch' statement
SK_ROBO_ 0:775667bb8069 100 DEBUG("CMCP320x_SPI::Read: 0x%02x - 0x%02x", _sample.bytes[0], _sample.bytes[1])
SK_ROBO_ 0:775667bb8069 101 //_sample.value >>= 1; // Adjust composite integer for 12 valid bits
SK_ROBO_ 0:775667bb8069 102 _sample.value &= 0x0FFF; // Mask out upper nibble of integer
SK_ROBO_ 0:775667bb8069 103
SK_ROBO_ 0:775667bb8069 104 DEBUG_LEAVE("CMCP320x_SPI::Read: %lu", _sample.value)
SK_ROBO_ 0:775667bb8069 105 return _sample.value;
SK_ROBO_ 0:775667bb8069 106 }
SK_ROBO_ 0:775667bb8069 107
SK_ROBO_ 0:775667bb8069 108 void CMCP320x_SPI::SetConfig(const bool p_settings) {
SK_ROBO_ 0:775667bb8069 109 DEBUG_LEAVE("CMCP320x_SPI::SetConfig: %x", (unsigned char)p_settings)
SK_ROBO_ 0:775667bb8069 110
SK_ROBO_ 0:775667bb8069 111 if (_settings) {
SK_ROBO_ 0:775667bb8069 112 _settings = 0x02;
SK_ROBO_ 0:775667bb8069 113 } else {
SK_ROBO_ 0:775667bb8069 114 _settings = 0x00;
SK_ROBO_ 0:775667bb8069 115 }
SK_ROBO_ 0:775667bb8069 116 }
SK_ROBO_ 0:775667bb8069 117
SK_ROBO_ 0:775667bb8069 118 bool CMCP320x_SPI::Shutdown(const bool p_shutdown) {
SK_ROBO_ 0:775667bb8069 119 // Sanity check
SK_ROBO_ 0:775667bb8069 120 if (_cs == NULL) {
SK_ROBO_ 0:775667bb8069 121 return false;
SK_ROBO_ 0:775667bb8069 122 }
SK_ROBO_ 0:775667bb8069 123
SK_ROBO_ 0:775667bb8069 124 _cs->write(p_shutdown == false ? 0 : 1);
SK_ROBO_ 0:775667bb8069 125
SK_ROBO_ 0:775667bb8069 126 return true;
SK_ROBO_ 0:775667bb8069 127 }
SK_ROBO_ 0:775667bb8069 128
SK_ROBO_ 0:775667bb8069 129 void CMCP320x_SPI::Read_3201() {
SK_ROBO_ 0:775667bb8069 130 if (_cs != NULL) {
SK_ROBO_ 0:775667bb8069 131 _cs->write(0);
SK_ROBO_ 0:775667bb8069 132 wait_us(1);
SK_ROBO_ 0:775667bb8069 133 }
SK_ROBO_ 0:775667bb8069 134 _sample.bytes[1] = _spiInstance->write(0);
SK_ROBO_ 0:775667bb8069 135 _sample.bytes[0] = _spiInstance->write(0);
SK_ROBO_ 0:775667bb8069 136 if (_cs != NULL) {
SK_ROBO_ 0:775667bb8069 137 _cs->write(1);
SK_ROBO_ 0:775667bb8069 138 }
SK_ROBO_ 0:775667bb8069 139 }
SK_ROBO_ 0:775667bb8069 140
SK_ROBO_ 0:775667bb8069 141 void CMCP320x_SPI::Read_320x(const Mcp320xChannels p_channels) {
SK_ROBO_ 0:775667bb8069 142 DEBUG_ENTER("CMCP320x_SPI::Read_320x: %d", (unsigned char)p_channels)
SK_ROBO_ 0:775667bb8069 143
SK_ROBO_ 0:775667bb8069 144 unsigned char _channels = (unsigned char)p_channels % _channelsNum;
SK_ROBO_ 0:775667bb8069 145 // Set start bit
SK_ROBO_ 0:775667bb8069 146 unsigned char mask = 0x04 | _settings; // Start bit set to 1 - See DS21298E-page 19 Clause 5.0 SERIAL COMMUNICATIONS
SK_ROBO_ 0:775667bb8069 147 // Set channel address
SK_ROBO_ 0:775667bb8069 148 unsigned char cmd0;
SK_ROBO_ 0:775667bb8069 149 unsigned char cmd1;
SK_ROBO_ 0:775667bb8069 150 if (_familly == _3204) {
SK_ROBO_ 0:775667bb8069 151 cmd0 = mask;
SK_ROBO_ 0:775667bb8069 152 cmd1 = _channels << 6; // MCP3204 has 4 channels in single-ended mode
SK_ROBO_ 0:775667bb8069 153 } else { // MCP3208
SK_ROBO_ 0:775667bb8069 154 cmd0 = mask | ((_channels & 0x04) >> 2); // Extract D2 bit - See DS21298E-page 19 Clause 5.0 SERIAL COMMUNICATIONS
SK_ROBO_ 0:775667bb8069 155 cmd1 = _channels << 6; // MCP3204 has 8 channels in single-ended mode
SK_ROBO_ 0:775667bb8069 156 }
SK_ROBO_ 0:775667bb8069 157 DEBUG("CMCP320x_SPI::Read_320x: cmd0:%02x - cmd1:%02x", cmd0, cmd1)
SK_ROBO_ 0:775667bb8069 158 if (_cs != NULL) {
SK_ROBO_ 0:775667bb8069 159 _cs->write(0);
SK_ROBO_ 0:775667bb8069 160 wait_us(1);
SK_ROBO_ 0:775667bb8069 161 }
SK_ROBO_ 0:775667bb8069 162 _spiInstance->write(cmd0); // Don't care of the result - See DS21298E-page 21 Clause 6.1 Using the MCP3204/3208 with Microcontroller (MCU) SPI Ports
SK_ROBO_ 0:775667bb8069 163 _sample.bytes[1] = _spiInstance->write(cmd1); // DS21298E-page 21 See FIGURE 6-1: SPI Communication using 8-bit segments (Mode 0,0: SCLK idles low)
SK_ROBO_ 0:775667bb8069 164 _sample.bytes[0] = _spiInstance->write(0);
SK_ROBO_ 0:775667bb8069 165 if (_cs != NULL) {
SK_ROBO_ 0:775667bb8069 166 _cs->write(1);
SK_ROBO_ 0:775667bb8069 167 }
SK_ROBO_ 0:775667bb8069 168
SK_ROBO_ 0:775667bb8069 169 DEBUG_LEAVE("CMCP320x_SPI::Read_320x")
SK_ROBO_ 0:775667bb8069 170 }
SK_ROBO_ 0:775667bb8069 171
SK_ROBO_ 0:775667bb8069 172 } // End of namespace MCP320x_SPI