Analog Devices / AD5270

Driver for the AD5270 digipot

Dependents:   ad5270-helloworld CN0357 CN0396

For additional information check out the mbed page of the Analog Devices wiki: https://wiki.analog.com/resources/tools-software/mbed-drivers-all

AD5270.h@0:18d434f6f122, 2016-05-03 (annotated)

Committer:
adisuciu
Date:
Tue May 03 12:55:30 2016 +0000
Revision:
0:18d434f6f122
Child:
1:9f9dd8c48e8a
Initial revision

Who changed what in which revision?

UserRevisionLine numberNew contents of line
adisuciu 0:18d434f6f122 1 /**
adisuciu 0:18d434f6f122 2 * @file AD5270.h
adisuciu 0:18d434f6f122 3 * @brief Header file for AD5270 rheostat
adisuciu 0:18d434f6f122 4 * @author Analog Devices Inc.
adisuciu 0:18d434f6f122 5 *
adisuciu 0:18d434f6f122 6 * For support please go to:
adisuciu 0:18d434f6f122 7 * Github: https://github.com/analogdevicesinc/mbed-adi
adisuciu 0:18d434f6f122 8 * Support: https://ez.analog.com/community/linux-device-drivers/microcontroller-no-os-drivers
adisuciu 0:18d434f6f122 9 * Product: http://www.analog.com/ad5270
adisuciu 0:18d434f6f122 10 * More: https://wiki.analog.com/resources/tools-software/mbed-drivers-all
adisuciu 0:18d434f6f122 11
adisuciu 0:18d434f6f122 12 ********************************************************************************
adisuciu 0:18d434f6f122 13 * Copyright 2016(c) Analog Devices, Inc.
adisuciu 0:18d434f6f122 14 *
adisuciu 0:18d434f6f122 15 * All rights reserved.
adisuciu 0:18d434f6f122 16 *
adisuciu 0:18d434f6f122 17 * Redistribution and use in source and binary forms, with or without
adisuciu 0:18d434f6f122 18 * modification, are permitted provided that the following conditions are met:
adisuciu 0:18d434f6f122 19 * - Redistributions of source code must retain the above copyright
adisuciu 0:18d434f6f122 20 * notice, this list of conditions and the following disclaimer.
adisuciu 0:18d434f6f122 21 * - Redistributions in binary form must reproduce the above copyright
adisuciu 0:18d434f6f122 22 * notice, this list of conditions and the following disclaimer in
adisuciu 0:18d434f6f122 23 * the documentation and/or other materials provided with the
adisuciu 0:18d434f6f122 24 * distribution.
adisuciu 0:18d434f6f122 25 * - Neither the name of Analog Devices, Inc. nor the names of its
adisuciu 0:18d434f6f122 26 * contributors may be used to endorse or promote products derived
adisuciu 0:18d434f6f122 27 * from this software without specific prior written permission.
adisuciu 0:18d434f6f122 28 * - The use of this software may or may not infringe the patent rights
adisuciu 0:18d434f6f122 29 * of one or more patent holders. This license does not release you
adisuciu 0:18d434f6f122 30 * from the requirement that you obtain separate licenses from these
adisuciu 0:18d434f6f122 31 * patent holders to use this software.
adisuciu 0:18d434f6f122 32 * - Use of the software either in source or binary form, must be run
adisuciu 0:18d434f6f122 33 * on or directly connected to an Analog Devices Inc. component.
adisuciu 0:18d434f6f122 34 *
adisuciu 0:18d434f6f122 35 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
adisuciu 0:18d434f6f122 36 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
adisuciu 0:18d434f6f122 37 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
adisuciu 0:18d434f6f122 38 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
adisuciu 0:18d434f6f122 39 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
adisuciu 0:18d434f6f122 40 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
adisuciu 0:18d434f6f122 41 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
adisuciu 0:18d434f6f122 42 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
adisuciu 0:18d434f6f122 43 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
adisuciu 0:18d434f6f122 44 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
adisuciu 0:18d434f6f122 45 *
adisuciu 0:18d434f6f122 46 ********************************************************************************/
adisuciu 0:18d434f6f122 47
adisuciu 0:18d434f6f122 48 #ifndef AD5270_H
adisuciu 0:18d434f6f122 49 #define AD5270_H
adisuciu 0:18d434f6f122 50
adisuciu 0:18d434f6f122 51 #include "mbed.h"
adisuciu 0:18d434f6f122 52
adisuciu 0:18d434f6f122 53 /**
adisuciu 0:18d434f6f122 54 * @brief Analog Devices AD5270 SPI Digital Rheostat class
adisuciu 0:18d434f6f122 55 */
adisuciu 0:18d434f6f122 56 class AD5270
adisuciu 0:18d434f6f122 57 {
adisuciu 0:18d434f6f122 58 public:
adisuciu 0:18d434f6f122 59
adisuciu 0:18d434f6f122 60 /// AD5270 commands
adisuciu 0:18d434f6f122 61 typedef enum {
adisuciu 0:18d434f6f122 62 NO_OP = 0x00, ///< No data
adisuciu 0:18d434f6f122 63 NO_OP_cmd = 0x0000, ///< 16 bit no data
adisuciu 0:18d434f6f122 64 WRITE_RDAC = 0x04, ///< Write to the RDAC Register
adisuciu 0:18d434f6f122 65 READ_RDAC = 0x08, ///< Read from the RDAC Register
adisuciu 0:18d434f6f122 66 STORE_50TP = 0x0C, ///< Write from RDAC to memory
adisuciu 0:18d434f6f122 67 SW_RST = 0x10, ///< Software reset to last memory location
adisuciu 0:18d434f6f122 68 READ_50TP_CONTENTS = 0x14, ///< Read the last memory contents
adisuciu 0:18d434f6f122 69 READ_50TP_ADDRESS = 0x18, ///< Read the last memory address
adisuciu 0:18d434f6f122 70 WRITE_CTRL_REG = 0x1C, ///< Write to the control Register
adisuciu 0:18d434f6f122 71 READ_CTRL_REG = 0x20, ///< Read from the control Register
adisuciu 0:18d434f6f122 72 SW_SHUTDOWN = 0x24, ///< Software shutdown (0) - Normal, (1) - Shutdown
adisuciu 0:18d434f6f122 73 HI_Zupper = 0x80, ///< Get the SDO line ready for High Z
adisuciu 0:18d434f6f122 74 HI_Zlower = 0x01, ///< Puts AD5270 into High Z mode
adisuciu 0:18d434f6f122 75 HI_Z_Cmd = 0x8001 ///< Puts AD5270 into High Z mode*/
adisuciu 0:18d434f6f122 76 } AD5270Commands_t;
adisuciu 0:18d434f6f122 77
adisuciu 0:18d434f6f122 78 typedef enum {
adisuciu 0:18d434f6f122 79 NORMAL_MODE = 0,
adisuciu 0:18d434f6f122 80 SHUTDOWN_MODE = 1
adisuciu 0:18d434f6f122 81 } AD5270Modes_t;
adisuciu 0:18d434f6f122 82
adisuciu 0:18d434f6f122 83 typedef enum {
adisuciu 0:18d434f6f122 84 PROGRAM_50TP_ENABLE = 1,
adisuciu 0:18d434f6f122 85 RDAC_WRITE_PROTECT = 2,
adisuciu 0:18d434f6f122 86 R_PERFORMANCE_ENABLE = 4,
adisuciu 0:18d434f6f122 87 MEMORY_PROGRAM_SUCCESFUL = 8
adisuciu 0:18d434f6f122 88 } AD5270ControlRegisterBits_t;
adisuciu 0:18d434f6f122 89
adisuciu 0:18d434f6f122 90 // SPI configuration & constructor
adisuciu 0:18d434f6f122 91 AD5270(PinName CS = SPI_CS, float max_resistance = 20000.0, PinName MOSI = SPI_MOSI, PinName MISO = SPI_MISO, PinName SCK = SPI_SCK);
adisuciu 0:18d434f6f122 92 void frequency(int hz);
adisuciu 0:18d434f6f122 93
adisuciu 0:18d434f6f122 94 /* RDAC commands */
adisuciu 0:18d434f6f122 95 void write_ctrl_reg(uint8_t data);
adisuciu 0:18d434f6f122 96 uint8_t read_ctrl_reg(void);
adisuciu 0:18d434f6f122 97 void change_mode(AD5270Modes_t mode);
adisuciu 0:18d434f6f122 98 void set_SDO_HiZ(void);
adisuciu 0:18d434f6f122 99
adisuciu 0:18d434f6f122 100 /* Wiper R/W methods*/
adisuciu 0:18d434f6f122 101 void reset_RDAC(void);
adisuciu 0:18d434f6f122 102 void write_wiper_reg(uint16_t data);
adisuciu 0:18d434f6f122 103 uint16_t read_wiper_reg(void);
adisuciu 0:18d434f6f122 104
adisuciu 0:18d434f6f122 105
adisuciu 0:18d434f6f122 106 /* Low level methods */
adisuciu 0:18d434f6f122 107 uint16_t write_cmd(uint8_t command, uint16_t data = 0x00);
adisuciu 0:18d434f6f122 108 uint16_t write_reg(uint16_t data);
adisuciu 0:18d434f6f122 109
adisuciu 0:18d434f6f122 110 /* Methods that deal with resistance in float format*/
adisuciu 0:18d434f6f122 111 uint16_t calc_RDAC(float resistance);
adisuciu 0:18d434f6f122 112 float write_RDAC(float resistance);
adisuciu 0:18d434f6f122 113 float read_RDAC(void);
adisuciu 0:18d434f6f122 114 float get_max_resistance(void);
adisuciu 0:18d434f6f122 115
adisuciu 0:18d434f6f122 116 /* 50 TP methods */
adisuciu 0:18d434f6f122 117 void enable_50TP_programming(void);
adisuciu 0:18d434f6f122 118 void store_50TP(void);
adisuciu 0:18d434f6f122 119 void disable_50TP_programming(void);
adisuciu 0:18d434f6f122 120 uint8_t read_50TP_last_address(void);
adisuciu 0:18d434f6f122 121 uint16_t read_50TP_memory(uint8_t address);
adisuciu 0:18d434f6f122 122
adisuciu 0:18d434f6f122 123 SPI ad5270; ///< SPI instance of the AD5270
adisuciu 0:18d434f6f122 124 DigitalOut cs; ///< DigitalOut instance for the chip select of the AD5270
adisuciu 0:18d434f6f122 125
adisuciu 0:18d434f6f122 126 private:
adisuciu 0:18d434f6f122 127 const static int _RESET = 0xff;
adisuciu 0:18d434f6f122 128 const static int _REG_OPERATION_TIMEOUT = 2;
adisuciu 0:18d434f6f122 129 const static int _MEMORY_OPERATION_TIMEOUT = 6;
adisuciu 0:18d434f6f122 130 const static int _WRITE_OPERATION_50TP_TIMEOUT = 350;
adisuciu 0:18d434f6f122 131 const static int _DUMMY_BYTE = 0xAA;
adisuciu 0:18d434f6f122 132 const static uint8_t _SPI_MODE = 1;
adisuciu 0:18d434f6f122 133 float _max_resistance;
adisuciu 0:18d434f6f122 134 };
adisuciu 0:18d434f6f122 135
adisuciu 0:18d434f6f122 136 #endif