Maxim Integrated
/
MAX5171
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: MAX5171BOB_Tester MAX5171BOB_14bit_Remote_Sense_SPI_DAC MAX5171BOB_Serial_Tester
MAX5171.h@5:e8c0dfaeb53b, 2020-03-12 (annotated)
- Committer:
- whismanoid
- Date:
- Thu Mar 12 23:33:56 2020 +0000
- Revision:
- 5:e8c0dfaeb53b
- Parent:
- 4:1984eef51fe3
- Child:
- 6:f661c4a61207
get_spi_frequency get_spi_mode
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| whismanoid | 1:e73245718b2a | 1 | // /******************************************************************************* |
| whismanoid | 5:e8c0dfaeb53b | 2 | // * Copyright (C) 2020 Maxim Integrated Products, Inc., All Rights Reserved. |
| whismanoid | 1:e73245718b2a | 3 | // * |
| whismanoid | 1:e73245718b2a | 4 | // * Permission is hereby granted, free of charge, to any person obtaining a |
| whismanoid | 1:e73245718b2a | 5 | // * copy of this software and associated documentation files (the "Software"), |
| whismanoid | 1:e73245718b2a | 6 | // * to deal in the Software without restriction, including without limitation |
| whismanoid | 1:e73245718b2a | 7 | // * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| whismanoid | 1:e73245718b2a | 8 | // * and/or sell copies of the Software, and to permit persons to whom the |
| whismanoid | 1:e73245718b2a | 9 | // * Software is furnished to do so, subject to the following conditions: |
| whismanoid | 1:e73245718b2a | 10 | // * |
| whismanoid | 1:e73245718b2a | 11 | // * The above copyright notice and this permission notice shall be included |
| whismanoid | 1:e73245718b2a | 12 | // * in all copies or substantial portions of the Software. |
| whismanoid | 1:e73245718b2a | 13 | // * |
| whismanoid | 1:e73245718b2a | 14 | // * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| whismanoid | 1:e73245718b2a | 15 | // * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| whismanoid | 1:e73245718b2a | 16 | // * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| whismanoid | 1:e73245718b2a | 17 | // * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
| whismanoid | 1:e73245718b2a | 18 | // * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| whismanoid | 1:e73245718b2a | 19 | // * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| whismanoid | 1:e73245718b2a | 20 | // * OTHER DEALINGS IN THE SOFTWARE. |
| whismanoid | 1:e73245718b2a | 21 | // * |
| whismanoid | 1:e73245718b2a | 22 | // * Except as contained in this notice, the name of Maxim Integrated |
| whismanoid | 1:e73245718b2a | 23 | // * Products, Inc. shall not be used except as stated in the Maxim Integrated |
| whismanoid | 1:e73245718b2a | 24 | // * Products, Inc. Branding Policy. |
| whismanoid | 1:e73245718b2a | 25 | // * |
| whismanoid | 1:e73245718b2a | 26 | // * The mere transfer of this software does not imply any licenses |
| whismanoid | 1:e73245718b2a | 27 | // * of trade secrets, proprietary technology, copyrights, patents, |
| whismanoid | 1:e73245718b2a | 28 | // * trademarks, maskwork rights, or any other form of intellectual |
| whismanoid | 1:e73245718b2a | 29 | // * property whatsoever. Maxim Integrated Products, Inc. retains all |
| whismanoid | 1:e73245718b2a | 30 | // * ownership rights. |
| whismanoid | 1:e73245718b2a | 31 | // ******************************************************************************* |
| whismanoid | 1:e73245718b2a | 32 | // */ |
| whismanoid | 1:e73245718b2a | 33 | // ********************************************************************* |
| whismanoid | 1:e73245718b2a | 34 | // @file MAX5171.h |
| whismanoid | 1:e73245718b2a | 35 | // ********************************************************************* |
| whismanoid | 1:e73245718b2a | 36 | // Header file |
| whismanoid | 1:e73245718b2a | 37 | // DO NOT EDIT; except areas designated "CUSTOMIZE". Automatically generated file. |
| whismanoid | 1:e73245718b2a | 38 | // generated by XMLSystemOfDevicesToMBED.py |
| whismanoid | 1:e73245718b2a | 39 | // System Name = ExampleSystem |
| whismanoid | 1:e73245718b2a | 40 | // System Description = Device driver example |
| whismanoid | 1:e73245718b2a | 41 | // Device Name = MAX5171 |
| whismanoid | 1:e73245718b2a | 42 | // Device Description = Low-Power, Serial, 14-Bit, 1-Channel DACs with Force/Sense Voltage Output and SPI Interface |
| whismanoid | 5:e8c0dfaeb53b | 43 | // Device DeviceBriefDescription = 14-bit Force/Sense DAC |
| whismanoid | 1:e73245718b2a | 44 | // Device Manufacturer = Maxim Integrated |
| whismanoid | 1:e73245718b2a | 45 | // Device PartNumber = MAX5171AEEE+ |
| whismanoid | 1:e73245718b2a | 46 | // Device RegValue_Width = DataWidth16bit_HL |
| whismanoid | 1:e73245718b2a | 47 | // |
| whismanoid | 1:e73245718b2a | 48 | // DAC NumChannels = 1 |
| whismanoid | 1:e73245718b2a | 49 | // DAC ResolutionBits = 14 |
| whismanoid | 1:e73245718b2a | 50 | // |
| whismanoid | 1:e73245718b2a | 51 | // SPI CS = ActiveLow |
| whismanoid | 1:e73245718b2a | 52 | // SPI FrameStart = CS |
| whismanoid | 1:e73245718b2a | 53 | // SPI CPOL = 0 |
| whismanoid | 1:e73245718b2a | 54 | // SPI CPHA = 0 |
| whismanoid | 1:e73245718b2a | 55 | // SPI MOSI and MISO Data are both stable on Rising edge of SCLK |
| whismanoid | 1:e73245718b2a | 56 | // SPI SCLK Idle Low |
| whismanoid | 1:e73245718b2a | 57 | // SPI SCLKMaxMHz = 10 |
| whismanoid | 1:e73245718b2a | 58 | // SPI SCLKMinMHz = 0 |
| whismanoid | 1:e73245718b2a | 59 | // |
| whismanoid | 1:e73245718b2a | 60 | |
| whismanoid | 1:e73245718b2a | 61 | |
| whismanoid | 1:e73245718b2a | 62 | // Prevent multiple declaration |
| whismanoid | 1:e73245718b2a | 63 | #ifndef __MAX5171_H__ |
| whismanoid | 1:e73245718b2a | 64 | #define __MAX5171_H__ |
| whismanoid | 1:e73245718b2a | 65 | |
| whismanoid | 5:e8c0dfaeb53b | 66 | // standard include for target platform -- Platform_Include_Boilerplate |
| whismanoid | 1:e73245718b2a | 67 | #include "mbed.h" |
| whismanoid | 5:e8c0dfaeb53b | 68 | // Platforms: |
| whismanoid | 5:e8c0dfaeb53b | 69 | // - MAX32625MBED |
| whismanoid | 5:e8c0dfaeb53b | 70 | // - supports mbed-os-5.11, requires USBDevice library |
| whismanoid | 5:e8c0dfaeb53b | 71 | // - add https://developer.mbed.org/teams/MaximIntegrated/code/USBDevice/ |
| whismanoid | 5:e8c0dfaeb53b | 72 | // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 73 | // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 74 | // - MAX32600MBED |
| whismanoid | 5:e8c0dfaeb53b | 75 | // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 76 | // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 77 | // - Windows 10 note: Don't connect HDK until you are ready to load new firmware into the board. |
| whismanoid | 5:e8c0dfaeb53b | 78 | // - NUCLEO_F446RE |
| whismanoid | 5:e8c0dfaeb53b | 79 | // - remove USBDevice library |
| whismanoid | 5:e8c0dfaeb53b | 80 | // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 81 | // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 82 | // - NUCLEO_F401RE |
| whismanoid | 5:e8c0dfaeb53b | 83 | // - remove USBDevice library |
| whismanoid | 5:e8c0dfaeb53b | 84 | // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 85 | // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 86 | // - MAX32630FTHR |
| whismanoid | 5:e8c0dfaeb53b | 87 | // - #include "max32630fthr.h" |
| whismanoid | 5:e8c0dfaeb53b | 88 | // - add http://os.mbed.org/teams/MaximIntegrated/code/max32630fthr/ |
| whismanoid | 5:e8c0dfaeb53b | 89 | // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 90 | // - MAX32620FTHR |
| whismanoid | 5:e8c0dfaeb53b | 91 | // - #include "MAX32620FTHR.h" |
| whismanoid | 5:e8c0dfaeb53b | 92 | // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 93 | // - add https://os.mbed.com/teams/MaximIntegrated/code/MAX32620FTHR/ |
| whismanoid | 5:e8c0dfaeb53b | 94 | // - not tested yet |
| whismanoid | 5:e8c0dfaeb53b | 95 | // - MAX32625PICO |
| whismanoid | 5:e8c0dfaeb53b | 96 | // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 97 | // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 98 | // - not tested yet |
| whismanoid | 5:e8c0dfaeb53b | 99 | // |
| whismanoid | 5:e8c0dfaeb53b | 100 | // end Platform_Include_Boilerplate |
| whismanoid | 1:e73245718b2a | 101 | |
| whismanoid | 1:e73245718b2a | 102 | /** |
| whismanoid | 1:e73245718b2a | 103 | * @brief MAX5171 Low-Power, Serial, 14-Bit, 1-Channel DACs with Force/Sense Voltage Output and SPI Interface |
| whismanoid | 1:e73245718b2a | 104 | * |
| whismanoid | 1:e73245718b2a | 105 | * |
| whismanoid | 1:e73245718b2a | 106 | * |
| whismanoid | 1:e73245718b2a | 107 | * Datasheet: https://www.maximintegrated.com/MAX5171 |
| whismanoid | 1:e73245718b2a | 108 | * |
| whismanoid | 1:e73245718b2a | 109 | * |
| whismanoid | 1:e73245718b2a | 110 | * |
| whismanoid | 1:e73245718b2a | 111 | * @code |
| whismanoid | 1:e73245718b2a | 112 | * // example code includes |
| whismanoid | 5:e8c0dfaeb53b | 113 | * // standard include for target platform -- Platform_Include_Boilerplate |
| whismanoid | 1:e73245718b2a | 114 | * #include "mbed.h" |
| whismanoid | 5:e8c0dfaeb53b | 115 | * // Platforms: |
| whismanoid | 5:e8c0dfaeb53b | 116 | * // - MAX32625MBED |
| whismanoid | 4:1984eef51fe3 | 117 | * // - supports mbed-os-5.11, requires USBDevice library |
| whismanoid | 5:e8c0dfaeb53b | 118 | * // - add https://developer.mbed.org/teams/MaximIntegrated/code/USBDevice/ |
| whismanoid | 5:e8c0dfaeb53b | 119 | * // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 120 | * // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 121 | * // - MAX32600MBED |
| whismanoid | 5:e8c0dfaeb53b | 122 | * // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 123 | * // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 124 | * // - Windows 10 note: Don't connect HDK until you are ready to load new firmware into the board. |
| whismanoid | 5:e8c0dfaeb53b | 125 | * // - NUCLEO_F446RE |
| whismanoid | 5:e8c0dfaeb53b | 126 | * // - remove USBDevice library |
| whismanoid | 5:e8c0dfaeb53b | 127 | * // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 128 | * // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 129 | * // - NUCLEO_F401RE |
| whismanoid | 5:e8c0dfaeb53b | 130 | * // - remove USBDevice library |
| whismanoid | 5:e8c0dfaeb53b | 131 | * // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 132 | * // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 133 | * // - MAX32630FTHR |
| whismanoid | 5:e8c0dfaeb53b | 134 | * // - #include "max32630fthr.h" |
| whismanoid | 5:e8c0dfaeb53b | 135 | * // - add http://os.mbed.org/teams/MaximIntegrated/code/max32630fthr/ |
| whismanoid | 5:e8c0dfaeb53b | 136 | * // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 137 | * // - MAX32620FTHR |
| whismanoid | 5:e8c0dfaeb53b | 138 | * // - #include "MAX32620FTHR.h" |
| whismanoid | 5:e8c0dfaeb53b | 139 | * // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 140 | * // - add https://os.mbed.com/teams/MaximIntegrated/code/MAX32620FTHR/ |
| whismanoid | 5:e8c0dfaeb53b | 141 | * // - not tested yet |
| whismanoid | 5:e8c0dfaeb53b | 142 | * // - MAX32625PICO |
| whismanoid | 5:e8c0dfaeb53b | 143 | * // - remove max32630fthr library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 144 | * // - remove MAX32620FTHR library (if present) |
| whismanoid | 5:e8c0dfaeb53b | 145 | * // - not tested yet |
| whismanoid | 5:e8c0dfaeb53b | 146 | * // |
| whismanoid | 5:e8c0dfaeb53b | 147 | * // end Platform_Include_Boilerplate |
| whismanoid | 1:e73245718b2a | 148 | * #include "MAX5171.h" |
| whismanoid | 1:e73245718b2a | 149 | * |
| whismanoid | 1:e73245718b2a | 150 | * // example code board support |
| whismanoid | 1:e73245718b2a | 151 | * //MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3); |
| whismanoid | 1:e73245718b2a | 152 | * //DigitalOut rLED(LED1); |
| whismanoid | 1:e73245718b2a | 153 | * //DigitalOut gLED(LED2); |
| whismanoid | 1:e73245718b2a | 154 | * //DigitalOut bLED(LED3); |
| whismanoid | 1:e73245718b2a | 155 | * // |
| whismanoid | 1:e73245718b2a | 156 | * // Arduino "shield" connector port definitions (MAX32625MBED shown) |
| whismanoid | 1:e73245718b2a | 157 | * #if defined(TARGET_MAX32625MBED) |
| whismanoid | 1:e73245718b2a | 158 | * #define A0 AIN_0 |
| whismanoid | 1:e73245718b2a | 159 | * #define A1 AIN_1 |
| whismanoid | 1:e73245718b2a | 160 | * #define A2 AIN_2 |
| whismanoid | 1:e73245718b2a | 161 | * #define A3 AIN_3 |
| whismanoid | 1:e73245718b2a | 162 | * #define D0 P0_0 |
| whismanoid | 1:e73245718b2a | 163 | * #define D1 P0_1 |
| whismanoid | 1:e73245718b2a | 164 | * #define D2 P0_2 |
| whismanoid | 1:e73245718b2a | 165 | * #define D3 P0_3 |
| whismanoid | 1:e73245718b2a | 166 | * #define D4 P0_4 |
| whismanoid | 1:e73245718b2a | 167 | * #define D5 P0_5 |
| whismanoid | 1:e73245718b2a | 168 | * #define D6 P0_6 |
| whismanoid | 1:e73245718b2a | 169 | * #define D7 P0_7 |
| whismanoid | 1:e73245718b2a | 170 | * #define D8 P1_4 |
| whismanoid | 1:e73245718b2a | 171 | * #define D9 P1_5 |
| whismanoid | 1:e73245718b2a | 172 | * #define D10 P1_3 |
| whismanoid | 1:e73245718b2a | 173 | * #define D11 P1_1 |
| whismanoid | 1:e73245718b2a | 174 | * #define D12 P1_2 |
| whismanoid | 1:e73245718b2a | 175 | * #define D13 P1_0 |
| whismanoid | 1:e73245718b2a | 176 | * #endif |
| whismanoid | 1:e73245718b2a | 177 | * |
| whismanoid | 1:e73245718b2a | 178 | * // example code declare SPI interface |
| whismanoid | 1:e73245718b2a | 179 | * #if defined(TARGET_MAX32625MBED) |
| whismanoid | 1:e73245718b2a | 180 | * SPI spi(SPI1_MOSI, SPI1_MISO, SPI1_SCK); // mosi, miso, sclk spi1 TARGET_MAX32625MBED: P1_1 P1_2 P1_0 Arduino 10-pin header D11 D12 D13 |
| whismanoid | 1:e73245718b2a | 181 | * DigitalOut spi_cs(SPI1_SS); // TARGET_MAX32625MBED: P1_3 Arduino 10-pin header D10 |
| whismanoid | 1:e73245718b2a | 182 | * #elif defined(TARGET_MAX32600MBED) |
| whismanoid | 1:e73245718b2a | 183 | * SPI spi(SPI2_MOSI, SPI2_MISO, SPI2_SCK); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13 |
| whismanoid | 1:e73245718b2a | 184 | * DigitalOut spi_cs(SPI2_SS); // Generic: Arduino 10-pin header D10 |
| whismanoid | 1:e73245718b2a | 185 | * #else |
| whismanoid | 1:e73245718b2a | 186 | * SPI spi(D11, D12, D13); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13 |
| whismanoid | 1:e73245718b2a | 187 | * DigitalOut spi_cs(D10); // Generic: Arduino 10-pin header D10 |
| whismanoid | 1:e73245718b2a | 188 | * #endif |
| whismanoid | 1:e73245718b2a | 189 | * |
| whismanoid | 1:e73245718b2a | 190 | * // example code declare GPIO interface pins |
| whismanoid | 1:e73245718b2a | 191 | * // AnalogOut FB_pin(Px_x_PortName_To_Be_Determined); // Analog Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 192 | * DigitalOut RS_pin(D9); // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 193 | * DigitalOut PDLb_pin(D8); // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 194 | * DigitalOut CLRb_pin(D7); // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 195 | * DigitalOut SHDN_pin(D6); // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 196 | * // AnalogIn OUT_pin(A0); // Analog Output from MAX5171 device |
| whismanoid | 1:e73245718b2a | 197 | * DigitalIn UPO_pin(D5); // Digital General-Purpose Output from MAX5171 device |
| whismanoid | 1:e73245718b2a | 198 | * // example code declare device instance |
| whismanoid | 1:e73245718b2a | 199 | * MAX5171 g_MAX5171_device(spi, spi_cs, RS_pin, PDLb_pin, CLRb_pin, SHDN_pin, UPO_pin, MAX5171::MAX5171_IC); |
| whismanoid | 1:e73245718b2a | 200 | * |
| whismanoid | 1:e73245718b2a | 201 | * // example code main function |
| whismanoid | 1:e73245718b2a | 202 | * int main() |
| whismanoid | 1:e73245718b2a | 203 | * { |
| whismanoid | 5:e8c0dfaeb53b | 204 | * g_MAX5171_device.Init(); |
| whismanoid | 5:e8c0dfaeb53b | 205 | * |
| whismanoid | 1:e73245718b2a | 206 | * while (1) |
| whismanoid | 1:e73245718b2a | 207 | * { |
| whismanoid | 5:e8c0dfaeb53b | 208 | * uint16_t code; |
| whismanoid | 5:e8c0dfaeb53b | 209 | * // |
| whismanoid | 5:e8c0dfaeb53b | 210 | * // example #1 |
| whismanoid | 5:e8c0dfaeb53b | 211 | * code = 0x3332; // 80.0% of full scale REF(2.50V) = 2.00V |
| whismanoid | 1:e73245718b2a | 212 | * g_MAX5171_device.CODE_LOAD(code); |
| whismanoid | 1:e73245718b2a | 213 | * // |
| whismanoid | 5:e8c0dfaeb53b | 214 | * // example #2 |
| whismanoid | 5:e8c0dfaeb53b | 215 | * code = 0x1fff; // 50.0% of full scale REF(2.50V) = 1.25V |
| whismanoid | 1:e73245718b2a | 216 | * g_MAX5171_device.CODE_LOAD(code); |
| whismanoid | 1:e73245718b2a | 217 | * // |
| whismanoid | 5:e8c0dfaeb53b | 218 | * // example #3 |
| whismanoid | 5:e8c0dfaeb53b | 219 | * code = 0x1999; // 40.0% of full scale REF(2.50V) = 1.00V |
| whismanoid | 4:1984eef51fe3 | 220 | * g_MAX5171_device.CODE_LOAD(code); |
| whismanoid | 4:1984eef51fe3 | 221 | * // |
| whismanoid | 5:e8c0dfaeb53b | 222 | * // example #4 |
| whismanoid | 5:e8c0dfaeb53b | 223 | * code = 0x3fff; // 100.0% of full scale REF(2.50V) = 2.50V |
| whismanoid | 1:e73245718b2a | 224 | * g_MAX5171_device.CODE_LOAD(code); |
| whismanoid | 1:e73245718b2a | 225 | * |
| whismanoid | 5:e8c0dfaeb53b | 226 | * // wait(3.0); |
| whismanoid | 1:e73245718b2a | 227 | * } |
| whismanoid | 1:e73245718b2a | 228 | * } |
| whismanoid | 1:e73245718b2a | 229 | * @endcode |
| whismanoid | 1:e73245718b2a | 230 | */ |
| whismanoid | 2:d1340b334b0d | 231 | class MAX5171 { |
| whismanoid | 1:e73245718b2a | 232 | public: |
| whismanoid | 1:e73245718b2a | 233 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 234 | /// Command Codes (first byte) |
| whismanoid | 1:e73245718b2a | 235 | /// |
| whismanoid | 1:e73245718b2a | 236 | /// Naming convention is CMD_bitstream_FUNCTION_NAME |
| whismanoid | 1:e73245718b2a | 237 | /// - dd_dddd_dddd_dddd = data field |
| whismanoid | 1:e73245718b2a | 238 | /// - xxxx = don't care |
| whismanoid | 1:e73245718b2a | 239 | typedef enum MAX5171_CMD_enum_t { |
| whismanoid | 1:e73245718b2a | 240 | CMD_00dd_dddd_dddd_dddd_CODE = 0x0000, //!< 16'b0000000000000000 |
| whismanoid | 1:e73245718b2a | 241 | CMD_01dd_dddd_dddd_dddd_CODE_LOAD = 0x4000, //!< 16'b0100000000000000 |
| whismanoid | 1:e73245718b2a | 242 | CMD_10xx_xxxx_xxxx_xxxx_LOAD = 0x8000, //!< 16'b1000000000000000 |
| whismanoid | 1:e73245718b2a | 243 | CMD_1100_xxxx_xxxx_xxxx_NOP = 0xc000, //!< 16'b1100000000000000 |
| whismanoid | 1:e73245718b2a | 244 | CMD_1101_xxxx_xxxx_xxxx_SHUTDOWN = 0xd000, //!< 16'b1101000000000000 |
| whismanoid | 1:e73245718b2a | 245 | CMD_1110_0xxx_xxxx_xxxx_UPO_LOW = 0xe000, //!< 16'b1110000000000000 |
| whismanoid | 1:e73245718b2a | 246 | CMD_1110_1xxx_xxxx_xxxx_UPO_HIGH = 0xe800, //!< 16'b1110100000000000 |
| whismanoid | 1:e73245718b2a | 247 | CMD_1111_0xxx_xxxx_xxxx_MODE1_DOUT_SCLK_RISING_EDGE = 0xf000, //!< 16'b1111000000000000 |
| whismanoid | 1:e73245718b2a | 248 | CMD_1111_1xxx_xxxx_xxxx_MODE0_DOUT_SCLK_FALLING_EDGE = 0xf800, //!< 16'b1111100000000000 |
| whismanoid | 1:e73245718b2a | 249 | } MAX5171_CMD_enum_t; |
| whismanoid | 1:e73245718b2a | 250 | |
| whismanoid | 1:e73245718b2a | 251 | /** |
| whismanoid | 1:e73245718b2a | 252 | * @brief IC's supported with this driver |
| whismanoid | 1:e73245718b2a | 253 | * @details MAX5171 |
| whismanoid | 1:e73245718b2a | 254 | */ |
| whismanoid | 2:d1340b334b0d | 255 | typedef enum |
| whismanoid | 2:d1340b334b0d | 256 | { |
| whismanoid | 1:e73245718b2a | 257 | MAX5171_IC = 0, |
| whismanoid | 1:e73245718b2a | 258 | //MAX5171_IC = 1 |
| whismanoid | 1:e73245718b2a | 259 | } MAX5171_ic_t; |
| whismanoid | 0:80a9add62408 | 260 | |
| whismanoid | 1:e73245718b2a | 261 | /**********************************************************//** |
| whismanoid | 1:e73245718b2a | 262 | * @brief Constructor for MAX5171 Class. |
| whismanoid | 1:e73245718b2a | 263 | * |
| whismanoid | 1:e73245718b2a | 264 | * @details Requires an existing SPI object as well as a DigitalOut object. |
| whismanoid | 1:e73245718b2a | 265 | * The DigitalOut object is used for a chip enable signal |
| whismanoid | 1:e73245718b2a | 266 | * |
| whismanoid | 1:e73245718b2a | 267 | * On Entry: |
| whismanoid | 1:e73245718b2a | 268 | * @param[in] spi - pointer to existing SPI object |
| whismanoid | 1:e73245718b2a | 269 | * @param[in] cs_pin - pointer to a DigitalOut pin object |
| whismanoid | 1:e73245718b2a | 270 | * @param[in] RS_pin - pointer to a DigitalOut pin object |
| whismanoid | 1:e73245718b2a | 271 | * @param[in] PDLb_pin - pointer to a DigitalOut pin object |
| whismanoid | 1:e73245718b2a | 272 | * @param[in] CLRb_pin - pointer to a DigitalOut pin object |
| whismanoid | 1:e73245718b2a | 273 | * @param[in] SHDN_pin - pointer to a DigitalOut pin object |
| whismanoid | 1:e73245718b2a | 274 | * @param[in] UPO_pin - pointer to a DigitalIn pin object |
| whismanoid | 1:e73245718b2a | 275 | * @param[in] ic_variant - which type of MAX5171 is used |
| whismanoid | 1:e73245718b2a | 276 | * |
| whismanoid | 1:e73245718b2a | 277 | * On Exit: |
| whismanoid | 1:e73245718b2a | 278 | * |
| whismanoid | 1:e73245718b2a | 279 | * @return None |
| whismanoid | 1:e73245718b2a | 280 | **************************************************************/ |
| whismanoid | 1:e73245718b2a | 281 | MAX5171(SPI &spi, DigitalOut &cs_pin, // SPI interface |
| whismanoid | 1:e73245718b2a | 282 | // AnalogOut &FB_pin, // Analog Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 283 | DigitalOut &RS_pin, // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 284 | DigitalOut &PDLb_pin, // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 285 | DigitalOut &CLRb_pin, // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 286 | DigitalOut &SHDN_pin, // Digital Configuration Input to MAX5171 device |
| whismanoid | 1:e73245718b2a | 287 | // AnalogIn &OUT_pin, // Analog Output from MAX5171 device |
| whismanoid | 1:e73245718b2a | 288 | DigitalIn &UPO_pin, // Digital General-Purpose Output from MAX5171 device |
| whismanoid | 1:e73245718b2a | 289 | MAX5171_ic_t ic_variant); |
| whismanoid | 1:e73245718b2a | 290 | |
| whismanoid | 1:e73245718b2a | 291 | /************************************************************ |
| whismanoid | 1:e73245718b2a | 292 | * @brief Default destructor for MAX5171 Class. |
| whismanoid | 1:e73245718b2a | 293 | * |
| whismanoid | 1:e73245718b2a | 294 | * @details Destroys SPI object if owner |
| whismanoid | 1:e73245718b2a | 295 | * |
| whismanoid | 1:e73245718b2a | 296 | * On Entry: |
| whismanoid | 1:e73245718b2a | 297 | * |
| whismanoid | 1:e73245718b2a | 298 | * On Exit: |
| whismanoid | 1:e73245718b2a | 299 | * |
| whismanoid | 1:e73245718b2a | 300 | * @return None |
| whismanoid | 1:e73245718b2a | 301 | **************************************************************/ |
| whismanoid | 1:e73245718b2a | 302 | ~MAX5171(); |
| whismanoid | 1:e73245718b2a | 303 | |
| whismanoid | 5:e8c0dfaeb53b | 304 | /// Function pointer void f(size_t byteCount, uint8_t mosiData[], uint8_t misoData[]) |
| whismanoid | 5:e8c0dfaeb53b | 305 | Callback<void(size_t, uint8_t*, uint8_t*)> onSPIprint; //!< optional @ref onSPIprint SPI diagnostic function |
| whismanoid | 5:e8c0dfaeb53b | 306 | |
| whismanoid | 5:e8c0dfaeb53b | 307 | /// set SPI SCLK frequency |
| whismanoid | 1:e73245718b2a | 308 | void spi_frequency(int spi_sclk_Hz); |
| whismanoid | 1:e73245718b2a | 309 | |
| whismanoid | 5:e8c0dfaeb53b | 310 | /// get SPI SCLK frequency |
| whismanoid | 5:e8c0dfaeb53b | 311 | int get_spi_frequency() const { return m_SPI_SCLK_Hz; } |
| whismanoid | 5:e8c0dfaeb53b | 312 | |
| whismanoid | 5:e8c0dfaeb53b | 313 | /// get SPI mode |
| whismanoid | 5:e8c0dfaeb53b | 314 | int get_spi_dataMode() const { return m_SPI_dataMode; } |
| whismanoid | 5:e8c0dfaeb53b | 315 | |
| whismanoid | 1:e73245718b2a | 316 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 317 | public: |
| whismanoid | 1:e73245718b2a | 318 | |
| whismanoid | 1:e73245718b2a | 319 | /// reference voltage, in Volts |
| whismanoid | 1:e73245718b2a | 320 | double VRef; |
| whismanoid | 1:e73245718b2a | 321 | |
| whismanoid | 5:e8c0dfaeb53b | 322 | /// shadow of dacCodeLsbs; write-only dacCodeLsbs field CMD_00dd_dddd_dddd_dddd_CODE or CMD_01dd_dddd_dddd_dddd_CODE_LOAD |
| whismanoid | 1:e73245718b2a | 323 | int16_t DACCode; |
| whismanoid | 1:e73245718b2a | 324 | |
| whismanoid | 1:e73245718b2a | 325 | |
| whismanoid | 1:e73245718b2a | 326 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 327 | // Assert SPI Chip Select |
| whismanoid | 1:e73245718b2a | 328 | // SPI chip-select for MAX5171 |
| whismanoid | 1:e73245718b2a | 329 | // |
| whismanoid | 1:e73245718b2a | 330 | void SPIoutputCS(int isLogicHigh); |
| whismanoid | 1:e73245718b2a | 331 | |
| whismanoid | 1:e73245718b2a | 332 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 333 | // SPI write 16 bits |
| whismanoid | 1:e73245718b2a | 334 | // SPI interface to MAX5171 shift 16 bits mosiData into MAX5171 DIN |
| whismanoid | 1:e73245718b2a | 335 | // |
| whismanoid | 1:e73245718b2a | 336 | void SPIwrite16bits(int16_t mosiData16); |
| whismanoid | 1:e73245718b2a | 337 | |
| whismanoid | 1:e73245718b2a | 338 | private: |
| whismanoid | 1:e73245718b2a | 339 | // SPI object |
| whismanoid | 1:e73245718b2a | 340 | SPI &m_spi; |
| whismanoid | 1:e73245718b2a | 341 | int m_SPI_SCLK_Hz; |
| whismanoid | 1:e73245718b2a | 342 | int m_SPI_dataMode; |
| whismanoid | 1:e73245718b2a | 343 | int m_SPI_cs_state; |
| whismanoid | 1:e73245718b2a | 344 | |
| whismanoid | 1:e73245718b2a | 345 | // Selector pin object |
| whismanoid | 1:e73245718b2a | 346 | DigitalOut &m_cs_pin; |
| whismanoid | 1:e73245718b2a | 347 | |
| whismanoid | 1:e73245718b2a | 348 | // InputPin Name = FB |
| whismanoid | 1:e73245718b2a | 349 | // InputPin Description = Feedback Input |
| whismanoid | 1:e73245718b2a | 350 | // InputPin Function = Analog |
| whismanoid | 1:e73245718b2a | 351 | // |
| whismanoid | 1:e73245718b2a | 352 | // InputPin Name = RS |
| whismanoid | 1:e73245718b2a | 353 | // InputPin Description = Reset Mode Select (digital input). Connect to VDD to select midscale reset output value. Connect to DGND |
| whismanoid | 1:e73245718b2a | 354 | // to select 0 reset output value. |
| whismanoid | 1:e73245718b2a | 355 | // InputPin Function = Configuration |
| whismanoid | 1:e73245718b2a | 356 | DigitalOut &m_RS_pin; |
| whismanoid | 1:e73245718b2a | 357 | // |
| whismanoid | 1:e73245718b2a | 358 | // InputPin Name = PDL# |
| whismanoid | 1:e73245718b2a | 359 | // InputPin Description = Power-Down Lockout (digital input). Connect to VDD to allow shutdown. Connect to DGND to disable shutdown. |
| whismanoid | 1:e73245718b2a | 360 | // InputPin Function = Configuration |
| whismanoid | 1:e73245718b2a | 361 | DigitalOut &m_PDLb_pin; |
| whismanoid | 1:e73245718b2a | 362 | // |
| whismanoid | 1:e73245718b2a | 363 | // InputPin Name = CLR# |
| whismanoid | 1:e73245718b2a | 364 | // InputPin Description = Clear DAC (digital input). Clears the DAC to its predetermined output state as set by RS. |
| whismanoid | 1:e73245718b2a | 365 | // InputPin Function = Configuration |
| whismanoid | 1:e73245718b2a | 366 | DigitalOut &m_CLRb_pin; |
| whismanoid | 1:e73245718b2a | 367 | // |
| whismanoid | 1:e73245718b2a | 368 | // InputPin Name = SHDN |
| whismanoid | 1:e73245718b2a | 369 | // InputPin Description = Shutdown (digital input). Pulling SHDN high when PDL = VDD places the chip in shutdown mode with a |
| whismanoid | 1:e73245718b2a | 370 | // maximum shutdown current 0f 10uA. |
| whismanoid | 1:e73245718b2a | 371 | // InputPin Function = Configuration |
| whismanoid | 1:e73245718b2a | 372 | DigitalOut &m_SHDN_pin; |
| whismanoid | 1:e73245718b2a | 373 | // |
| whismanoid | 1:e73245718b2a | 374 | // OutputPin Name = OUT |
| whismanoid | 1:e73245718b2a | 375 | // OutputPin Description = Analog Voltage Output. High impedance in shutdown. Output voltage is limited to VDD. |
| whismanoid | 1:e73245718b2a | 376 | // OutputPin Function = Analog |
| whismanoid | 1:e73245718b2a | 377 | // AnalogIn &m_OUT_pin; |
| whismanoid | 1:e73245718b2a | 378 | // |
| whismanoid | 1:e73245718b2a | 379 | // OutputPin Name = UPO |
| whismanoid | 1:e73245718b2a | 380 | // OutputPin Description = User-Programmable Output. State is set by serial input. |
| whismanoid | 1:e73245718b2a | 381 | // OutputPin Function = General-Purpose |
| whismanoid | 1:e73245718b2a | 382 | DigitalIn &m_UPO_pin; |
| whismanoid | 1:e73245718b2a | 383 | // |
| whismanoid | 1:e73245718b2a | 384 | |
| whismanoid | 1:e73245718b2a | 385 | // Identifies which IC variant is being used |
| whismanoid | 1:e73245718b2a | 386 | MAX5171_ic_t m_ic_variant; |
| whismanoid | 1:e73245718b2a | 387 | |
| whismanoid | 1:e73245718b2a | 388 | public: |
| whismanoid | 1:e73245718b2a | 389 | |
| whismanoid | 1:e73245718b2a | 390 | //---------------------------------------- |
| whismanoid | 5:e8c0dfaeb53b | 391 | /// Menu item '!' |
| whismanoid | 1:e73245718b2a | 392 | /// Initialize device |
| whismanoid | 1:e73245718b2a | 393 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 394 | uint8_t Init(void); |
| whismanoid | 1:e73245718b2a | 395 | |
| whismanoid | 1:e73245718b2a | 396 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 397 | /// Return the DAC register value corresponding to physical voltage. |
| whismanoid | 1:e73245718b2a | 398 | /// Does not perform any offset or gain correction. |
| whismanoid | 1:e73245718b2a | 399 | /// |
| whismanoid | 1:e73245718b2a | 400 | /// @pre g_MAX5171_device.VRef = Voltage of REF input, in Volts |
| whismanoid | 1:e73245718b2a | 401 | /// @param[in] voltage = physical voltage in Volts |
| whismanoid | 1:e73245718b2a | 402 | /// @return raw 14-bit MAX5171 code (right justified). |
| whismanoid | 1:e73245718b2a | 403 | uint16_t DACCodeOfVoltage(double voltageV); |
| whismanoid | 1:e73245718b2a | 404 | |
| whismanoid | 1:e73245718b2a | 405 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 406 | /// Return the physical voltage corresponding to DAC register. |
| whismanoid | 1:e73245718b2a | 407 | /// Does not perform any offset or gain correction. |
| whismanoid | 1:e73245718b2a | 408 | /// |
| whismanoid | 1:e73245718b2a | 409 | /// @pre g_MAX5171_device.VRef = Voltage of REF input, in Volts |
| whismanoid | 1:e73245718b2a | 410 | /// @param[in] value_u14: raw 14-bit MAX5171 code (right justified). |
| whismanoid | 1:e73245718b2a | 411 | /// @return physical voltage corresponding to MAX5171 code. |
| whismanoid | 1:e73245718b2a | 412 | double VoltageOfCode(uint16_t value_u14); |
| whismanoid | 1:e73245718b2a | 413 | |
| whismanoid | 1:e73245718b2a | 414 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 415 | /// CMD_00dd_dddd_dddd_dddd_CODE |
| whismanoid | 1:e73245718b2a | 416 | /// |
| whismanoid | 1:e73245718b2a | 417 | /// Load input register; DAC registers are unchanged. |
| whismanoid | 1:e73245718b2a | 418 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 419 | uint8_t CODE(uint16_t dacCodeLsbs); |
| whismanoid | 1:e73245718b2a | 420 | |
| whismanoid | 1:e73245718b2a | 421 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 422 | /// CMD_01dd_dddd_dddd_dddd_CODE_LOAD |
| whismanoid | 1:e73245718b2a | 423 | /// |
| whismanoid | 1:e73245718b2a | 424 | /// Load input register; DAC registers are updated (start up DAC with new data). |
| whismanoid | 1:e73245718b2a | 425 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 426 | uint8_t CODE_LOAD(uint16_t dacCodeLsbs); |
| whismanoid | 1:e73245718b2a | 427 | |
| whismanoid | 1:e73245718b2a | 428 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 429 | /// CMD_10xx_xxxx_xxxx_xxxx_LOAD |
| whismanoid | 1:e73245718b2a | 430 | /// |
| whismanoid | 1:e73245718b2a | 431 | /// Update DAC register from input register (start up DAC with data previously |
| whismanoid | 1:e73245718b2a | 432 | /// stored in the input registers). |
| whismanoid | 1:e73245718b2a | 433 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 434 | uint8_t LOAD(void); |
| whismanoid | 1:e73245718b2a | 435 | |
| whismanoid | 1:e73245718b2a | 436 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 437 | /// CMD_1100_xxxx_xxxx_xxxx_NOP |
| whismanoid | 1:e73245718b2a | 438 | /// |
| whismanoid | 1:e73245718b2a | 439 | /// No operation (NOP). |
| whismanoid | 1:e73245718b2a | 440 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 441 | uint8_t NOP(void); |
| whismanoid | 1:e73245718b2a | 442 | |
| whismanoid | 1:e73245718b2a | 443 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 444 | /// CMD_1101_xxxx_xxxx_xxxx_SHUTDOWN |
| whismanoid | 1:e73245718b2a | 445 | /// |
| whismanoid | 1:e73245718b2a | 446 | /// Shut down DAC (provided PDL# = 1). |
| whismanoid | 1:e73245718b2a | 447 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 448 | uint8_t SHUTDOWN(void); |
| whismanoid | 1:e73245718b2a | 449 | |
| whismanoid | 1:e73245718b2a | 450 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 451 | /// CMD_1110_0xxx_xxxx_xxxx_UPO_LOW |
| whismanoid | 1:e73245718b2a | 452 | /// |
| whismanoid | 1:e73245718b2a | 453 | /// UPO goes low (default). |
| whismanoid | 1:e73245718b2a | 454 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 455 | uint8_t UPO_LOW(void); |
| whismanoid | 1:e73245718b2a | 456 | |
| whismanoid | 1:e73245718b2a | 457 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 458 | /// CMD_1110_1xxx_xxxx_xxxx_UPO_HIGH |
| whismanoid | 1:e73245718b2a | 459 | /// |
| whismanoid | 1:e73245718b2a | 460 | /// UPO goes high. |
| whismanoid | 1:e73245718b2a | 461 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 462 | uint8_t UPO_HIGH(void); |
| whismanoid | 1:e73245718b2a | 463 | |
| whismanoid | 1:e73245718b2a | 464 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 465 | /// CMD_1111_0xxx_xxxx_xxxx_MODE1_DOUT_SCLK_RISING_EDGE |
| whismanoid | 1:e73245718b2a | 466 | /// |
| whismanoid | 5:e8c0dfaeb53b | 467 | /// Mode 1, DOUT clocked out on SCLK's rising edge. |
| whismanoid | 1:e73245718b2a | 468 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 469 | uint8_t MODE1_DOUT_SCLK_RISING_EDGE(void); |
| whismanoid | 1:e73245718b2a | 470 | |
| whismanoid | 1:e73245718b2a | 471 | //---------------------------------------- |
| whismanoid | 1:e73245718b2a | 472 | /// CMD_1111_1xxx_xxxx_xxxx_MODE0_DOUT_SCLK_FALLING_EDGE |
| whismanoid | 1:e73245718b2a | 473 | /// |
| whismanoid | 5:e8c0dfaeb53b | 474 | /// Mode 0, DOUT clocked out on SCLK's falling edge (default). |
| whismanoid | 1:e73245718b2a | 475 | /// @return 1 on success; 0 on failure |
| whismanoid | 1:e73245718b2a | 476 | uint8_t MODE0_DOUT_SCLK_FALLING_EDGE(void); |
| whismanoid | 1:e73245718b2a | 477 | |
| whismanoid | 1:e73245718b2a | 478 | }; // end of class MAX5171 |
| whismanoid | 1:e73245718b2a | 479 | |
| whismanoid | 1:e73245718b2a | 480 | #endif // __MAX5171_H__ |
| whismanoid | 1:e73245718b2a | 481 | |
| whismanoid | 1:e73245718b2a | 482 | // End of file |
Repository toolbox
Repository details
| Type: | Library |
|---|---|
| Created: | 05 Jun 2019 |
| Imports: | 3 |
| Forks: | 0 |
| Commits: | 8 |
| Dependents: | 3 |
| Dependencies: | 0 |
| Followers: | 109 |
The code in this repository is Apache licensed.
Components
MAX5171BOB