Maxim Integrated
Maxim Integrated MAX5715 12-bit 4-channel voltage-output DAC
Dependents: MAX5715BOB_Tester MAX5715BOB_12bit_4ch_SPI_DAC MAX5715BOB_Serial_Tester
MAX5715.h@3:a3f0518094f4, 2019-08-04 (annotated)
- Committer:
- whismanoid
- Date:
- Sun Aug 04 01:47:26 2019 -0700
- Revision:
- 3:a3f0518094f4
- Parent:
- 2:9d395fe10dbe
- Child:
- 4:500c80398f90
MAX5715 demo CODEnLOADn improved comments
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| whismanoid | 0:777851395940 | 1 | // /******************************************************************************* |
| whismanoid | 0:777851395940 | 2 | // * Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved. |
| whismanoid | 0:777851395940 | 3 | // * |
| whismanoid | 0:777851395940 | 4 | // * Permission is hereby granted, free of charge, to any person obtaining a |
| whismanoid | 0:777851395940 | 5 | // * copy of this software and associated documentation files (the "Software"), |
| whismanoid | 0:777851395940 | 6 | // * to deal in the Software without restriction, including without limitation |
| whismanoid | 0:777851395940 | 7 | // * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| whismanoid | 0:777851395940 | 8 | // * and/or sell copies of the Software, and to permit persons to whom the |
| whismanoid | 0:777851395940 | 9 | // * Software is furnished to do so, subject to the following conditions: |
| whismanoid | 0:777851395940 | 10 | // * |
| whismanoid | 0:777851395940 | 11 | // * The above copyright notice and this permission notice shall be included |
| whismanoid | 0:777851395940 | 12 | // * in all copies or substantial portions of the Software. |
| whismanoid | 0:777851395940 | 13 | // * |
| whismanoid | 0:777851395940 | 14 | // * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| whismanoid | 0:777851395940 | 15 | // * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| whismanoid | 0:777851395940 | 16 | // * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| whismanoid | 0:777851395940 | 17 | // * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
| whismanoid | 0:777851395940 | 18 | // * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| whismanoid | 0:777851395940 | 19 | // * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| whismanoid | 0:777851395940 | 20 | // * OTHER DEALINGS IN THE SOFTWARE. |
| whismanoid | 0:777851395940 | 21 | // * |
| whismanoid | 0:777851395940 | 22 | // * Except as contained in this notice, the name of Maxim Integrated |
| whismanoid | 0:777851395940 | 23 | // * Products, Inc. shall not be used except as stated in the Maxim Integrated |
| whismanoid | 0:777851395940 | 24 | // * Products, Inc. Branding Policy. |
| whismanoid | 0:777851395940 | 25 | // * |
| whismanoid | 0:777851395940 | 26 | // * The mere transfer of this software does not imply any licenses |
| whismanoid | 0:777851395940 | 27 | // * of trade secrets, proprietary technology, copyrights, patents, |
| whismanoid | 0:777851395940 | 28 | // * trademarks, maskwork rights, or any other form of intellectual |
| whismanoid | 0:777851395940 | 29 | // * property whatsoever. Maxim Integrated Products, Inc. retains all |
| whismanoid | 0:777851395940 | 30 | // * ownership rights. |
| whismanoid | 0:777851395940 | 31 | // ******************************************************************************* |
| whismanoid | 0:777851395940 | 32 | // */ |
| whismanoid | 0:777851395940 | 33 | // ********************************************************************* |
| whismanoid | 0:777851395940 | 34 | // @file MAX5715.h |
| whismanoid | 0:777851395940 | 35 | // ********************************************************************* |
| whismanoid | 0:777851395940 | 36 | // Header file |
| whismanoid | 0:777851395940 | 37 | // DO NOT EDIT; except areas designated "CUSTOMIZE". Automatically generated file. |
| whismanoid | 0:777851395940 | 38 | // generated by XMLSystemOfDevicesToMBED.py |
| whismanoid | 0:777851395940 | 39 | // System Name = ExampleSystem |
| whismanoid | 0:777851395940 | 40 | // System Description = Device driver example |
| whismanoid | 0:777851395940 | 41 | // Device Name = MAX5715 |
| whismanoid | 0:777851395940 | 42 | // Device Description = Ultra-Small, 12-Bit, 4-Channel, Buffered Output Voltage DAC with Internal Reference and SPI Interface |
| whismanoid | 0:777851395940 | 43 | // Device Manufacturer = Maxim Integrated |
| whismanoid | 0:777851395940 | 44 | // Device PartNumber = MAX5715AAUD+ |
| whismanoid | 0:777851395940 | 45 | // Device RegValue_Width = DataWidth16bit_HL |
| whismanoid | 0:777851395940 | 46 | // |
| whismanoid | 0:777851395940 | 47 | // DAC NumChannels = 4 |
| whismanoid | 0:777851395940 | 48 | // DAC ResolutionBits = 12 |
| whismanoid | 0:777851395940 | 49 | // |
| whismanoid | 0:777851395940 | 50 | // SPI CS = ActiveLow |
| whismanoid | 0:777851395940 | 51 | // SPI FrameStart = CS |
| whismanoid | 0:777851395940 | 52 | // SPI CPOL = 1 |
| whismanoid | 0:777851395940 | 53 | // SPI CPHA = 0 |
| whismanoid | 0:777851395940 | 54 | // SPI MOSI and MISO Data are both stable on Falling edge of SCLK |
| whismanoid | 0:777851395940 | 55 | // SPI SCLK Idle High |
| whismanoid | 0:777851395940 | 56 | // SPI SCLKMaxMHz = 50 |
| whismanoid | 0:777851395940 | 57 | // SPI SCLKMinMHz = 0 |
| whismanoid | 0:777851395940 | 58 | // |
| whismanoid | 0:777851395940 | 59 | |
| whismanoid | 0:777851395940 | 60 | |
| whismanoid | 0:777851395940 | 61 | // Prevent multiple declaration |
| whismanoid | 0:777851395940 | 62 | #ifndef __MAX5715_H__ |
| whismanoid | 0:777851395940 | 63 | #define __MAX5715_H__ |
| whismanoid | 0:777851395940 | 64 | |
| whismanoid | 3:a3f0518094f4 | 65 | // standard include for target platform |
| whismanoid | 0:777851395940 | 66 | #include "mbed.h" |
| whismanoid | 0:777851395940 | 67 | |
| whismanoid | 0:777851395940 | 68 | // CODE GENERATOR: conditional defines |
| whismanoid | 0:777851395940 | 69 | // CODE GENERATOR: class declaration and docstrings |
| whismanoid | 0:777851395940 | 70 | /** |
| whismanoid | 0:777851395940 | 71 | * @brief MAX5715 Ultra-Small, 12-Bit, 4-Channel, Buffered Output Voltage DAC with Internal Reference and SPI Interface |
| whismanoid | 0:777851395940 | 72 | * |
| whismanoid | 1:7a5d38577aa1 | 73 | * |
| whismanoid | 1:7a5d38577aa1 | 74 | * |
| whismanoid | 1:7a5d38577aa1 | 75 | * Datasheet: https://www.maximintegrated.com/MAX5715 |
| whismanoid | 1:7a5d38577aa1 | 76 | * |
| whismanoid | 1:7a5d38577aa1 | 77 | * |
| whismanoid | 1:7a5d38577aa1 | 78 | * |
| whismanoid | 2:9d395fe10dbe | 79 | * //---------- CODE GENERATOR: helloCppCodeList |
| whismanoid | 0:777851395940 | 80 | * @code |
| whismanoid | 0:777851395940 | 81 | * // CODE GENERATOR: example code includes |
| whismanoid | 0:777851395940 | 82 | * // example code includes |
| whismanoid | 3:a3f0518094f4 | 83 | * // standard include for target platform |
| whismanoid | 0:777851395940 | 84 | * #include "mbed.h" |
| whismanoid | 0:777851395940 | 85 | * //#include "max32625.h" |
| whismanoid | 0:777851395940 | 86 | * #include "MAX5715.h" |
| whismanoid | 0:777851395940 | 87 | * |
| whismanoid | 0:777851395940 | 88 | * // example code board support |
| whismanoid | 0:777851395940 | 89 | * //MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3); |
| whismanoid | 0:777851395940 | 90 | * //DigitalOut rLED(LED1); |
| whismanoid | 0:777851395940 | 91 | * //DigitalOut gLED(LED2); |
| whismanoid | 0:777851395940 | 92 | * //DigitalOut bLED(LED3); |
| whismanoid | 0:777851395940 | 93 | * // |
| whismanoid | 0:777851395940 | 94 | * // Arduino "shield" connector port definitions (MAX32625MBED shown) |
| whismanoid | 0:777851395940 | 95 | * #if defined(TARGET_MAX32625MBED) |
| whismanoid | 0:777851395940 | 96 | * #define A0 AIN_0 |
| whismanoid | 0:777851395940 | 97 | * #define A1 AIN_1 |
| whismanoid | 0:777851395940 | 98 | * #define A2 AIN_2 |
| whismanoid | 0:777851395940 | 99 | * #define A3 AIN_3 |
| whismanoid | 0:777851395940 | 100 | * #define D0 P0_0 |
| whismanoid | 0:777851395940 | 101 | * #define D1 P0_1 |
| whismanoid | 0:777851395940 | 102 | * #define D2 P0_2 |
| whismanoid | 0:777851395940 | 103 | * #define D3 P0_3 |
| whismanoid | 0:777851395940 | 104 | * #define D4 P0_4 |
| whismanoid | 0:777851395940 | 105 | * #define D5 P0_5 |
| whismanoid | 0:777851395940 | 106 | * #define D6 P0_6 |
| whismanoid | 0:777851395940 | 107 | * #define D7 P0_7 |
| whismanoid | 0:777851395940 | 108 | * #define D8 P1_4 |
| whismanoid | 0:777851395940 | 109 | * #define D9 P1_5 |
| whismanoid | 0:777851395940 | 110 | * #define D10 P1_3 |
| whismanoid | 0:777851395940 | 111 | * #define D11 P1_1 |
| whismanoid | 0:777851395940 | 112 | * #define D12 P1_2 |
| whismanoid | 0:777851395940 | 113 | * #define D13 P1_0 |
| whismanoid | 0:777851395940 | 114 | * #endif |
| whismanoid | 0:777851395940 | 115 | * |
| whismanoid | 0:777851395940 | 116 | * // example code declare SPI interface |
| whismanoid | 0:777851395940 | 117 | * #if defined(TARGET_MAX32625MBED) |
| whismanoid | 0:777851395940 | 118 | * 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 | 0:777851395940 | 119 | * DigitalOut spi_cs(SPI1_SS); // TARGET_MAX32625MBED: P1_3 Arduino 10-pin header D10 |
| whismanoid | 0:777851395940 | 120 | * #elif defined(TARGET_MAX32600MBED) |
| whismanoid | 0:777851395940 | 121 | * SPI spi(SPI2_MOSI, SPI2_MISO, SPI2_SCK); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13 |
| whismanoid | 0:777851395940 | 122 | * DigitalOut spi_cs(SPI2_SS); // Generic: Arduino 10-pin header D10 |
| whismanoid | 0:777851395940 | 123 | * #else |
| whismanoid | 0:777851395940 | 124 | * SPI spi(D11, D12, D13); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13 |
| whismanoid | 0:777851395940 | 125 | * DigitalOut spi_cs(D10); // Generic: Arduino 10-pin header D10 |
| whismanoid | 0:777851395940 | 126 | * #endif |
| whismanoid | 0:777851395940 | 127 | * |
| whismanoid | 0:777851395940 | 128 | * // example code declare GPIO interface pins |
| whismanoid | 0:777851395940 | 129 | * DigitalOut LDACb_pin(D9); // Digital Trigger Input to MAX5715 device |
| whismanoid | 0:777851395940 | 130 | * DigitalOut CLRb_pin(D8); // Digital Trigger Input to MAX5715 device |
| whismanoid | 0:777851395940 | 131 | * // AnalogOut REF_pin(Px_x_PortName_To_Be_Determined); // Reference Input to MAX5715 device |
| whismanoid | 0:777851395940 | 132 | * // AnalogIn OUTA_pin(A0); // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 133 | * // AnalogIn OUTB_pin(A1); // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 134 | * // AnalogIn OUTC_pin(A2); // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 135 | * // AnalogIn OUTD_pin(A3); // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 136 | * // DigitalIn RDYb_pin(Px_x_PortName_To_Be_Determined); // Digital MAX5715 Output from MAX5715 device |
| whismanoid | 0:777851395940 | 137 | * // example code declare device instance |
| whismanoid | 0:777851395940 | 138 | * MAX5715 g_MAX5715_device(spi, spi_cs, LDACb_pin, CLRb_pin, MAX5715::MAX5715_IC); |
| whismanoid | 0:777851395940 | 139 | * |
| whismanoid | 0:777851395940 | 140 | * // example code main function |
| whismanoid | 0:777851395940 | 141 | * int main() |
| whismanoid | 0:777851395940 | 142 | * { |
| whismanoid | 0:777851395940 | 143 | * while (1) |
| whismanoid | 0:777851395940 | 144 | * { |
| whismanoid | 0:777851395940 | 145 | * // CODE GENERATOR: example code: member function Init |
| whismanoid | 0:777851395940 | 146 | * g_MAX5715_device.Init(); |
| whismanoid | 0:777851395940 | 147 | * |
| whismanoid | 0:777851395940 | 148 | * // CODE GENERATOR: example code: member function REF |
| whismanoid | 0:777851395940 | 149 | * // CODE GENERATOR: example code: device has enumType 'MAX5715_REF_enum_t' |
| whismanoid | 0:777851395940 | 150 | * // CODE GENERATOR: TypedefEnum_MAXxxxxx_REF_enum_t_NamesList: REF_EXT, REF_2V500, REF_2V048, REF_4V096, REF_AlwaysOn_EXT, REF_AlwaysOn_2V500, REF_AlwaysOn_2V048, REF_AlwaysOn_4V096 |
| whismanoid | 0:777851395940 | 151 | * g_MAX5715_device.REF(MAX5715::REF_AlwaysOn_2V500); |
| whismanoid | 0:777851395940 | 152 | * |
| whismanoid | 0:777851395940 | 153 | * // CODE GENERATOR: example code: has no member function CODE_LOAD |
| whismanoid | 0:777851395940 | 154 | * // CODE GENERATOR: example code: member function CODEallLOADall |
| whismanoid | 0:777851395940 | 155 | * //uint16_t code = 4095; |
| whismanoid | 0:777851395940 | 156 | * //g_MAX5715_device.CODEallLOADall(code); |
| whismanoid | 0:777851395940 | 157 | * |
| whismanoid | 0:777851395940 | 158 | * // CODE GENERATOR: example code: member function CODEnLOADn |
| whismanoid | 3:a3f0518094f4 | 159 | * uint16_t ch; |
| whismanoid | 3:a3f0518094f4 | 160 | * uint16_t code; |
| whismanoid | 0:777851395940 | 161 | * // |
| whismanoid | 3:a3f0518094f4 | 162 | * ch = 0; |
| whismanoid | 3:a3f0518094f4 | 163 | * code = 0x0ccc; // 80.0% 2.00V (REF=2.50V) |
| whismanoid | 0:777851395940 | 164 | * g_MAX5715_device.CODEnLOADn(ch, code); |
| whismanoid | 0:777851395940 | 165 | * // |
| whismanoid | 0:777851395940 | 166 | * ch = 1; |
| whismanoid | 3:a3f0518094f4 | 167 | * code = 0x07ff; // 50.0% 1.25V (REF=2.50V) |
| whismanoid | 0:777851395940 | 168 | * g_MAX5715_device.CODEnLOADn(ch, code); |
| whismanoid | 0:777851395940 | 169 | * // |
| whismanoid | 0:777851395940 | 170 | * ch = 2; |
| whismanoid | 3:a3f0518094f4 | 171 | * code = 0x0666; // 40.0% 1.00V (REF=2.50V) |
| whismanoid | 0:777851395940 | 172 | * g_MAX5715_device.CODEnLOADn(ch, code); |
| whismanoid | 0:777851395940 | 173 | * // |
| whismanoid | 0:777851395940 | 174 | * ch = 3; |
| whismanoid | 3:a3f0518094f4 | 175 | * code = 0x0fff; // 100.0% 2.50V (REF=2.50V) |
| whismanoid | 0:777851395940 | 176 | * g_MAX5715_device.CODEnLOADn(ch, code); |
| whismanoid | 0:777851395940 | 177 | * |
| whismanoid | 0:777851395940 | 178 | * // CODE GENERATOR: example code: has no member function ScanManual |
| whismanoid | 0:777851395940 | 179 | * // CODE GENERATOR: example code: has no member function ReadAINcode |
| whismanoid | 0:777851395940 | 180 | * wait(3.0); |
| whismanoid | 0:777851395940 | 181 | * } |
| whismanoid | 0:777851395940 | 182 | * } |
| whismanoid | 0:777851395940 | 183 | * @endcode |
| whismanoid | 2:9d395fe10dbe | 184 | * //---------- CODE GENERATOR: end helloCppCodeList |
| whismanoid | 0:777851395940 | 185 | */ |
| whismanoid | 0:777851395940 | 186 | class MAX5715 { |
| whismanoid | 0:777851395940 | 187 | public: |
| whismanoid | 0:777851395940 | 188 | // CODE GENERATOR: TypedefEnum EnumItem declarations |
| whismanoid | 0:777851395940 | 189 | // CODE GENERATOR: TypedefEnum MAX5715_CMD_enum_t |
| whismanoid | 0:777851395940 | 190 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 191 | /// Command Codes (first byte) |
| whismanoid | 0:777851395940 | 192 | /// |
| whismanoid | 0:777851395940 | 193 | /// Naming convention is CMD_bitstream_FUNCTION_NAME |
| whismanoid | 0:777851395940 | 194 | /// - nnnn = channel selection |
| whismanoid | 0:777851395940 | 195 | /// - dcba = channel bitmask |
| whismanoid | 0:777851395940 | 196 | /// - dddd_dddd_dddd = data field |
| whismanoid | 0:777851395940 | 197 | /// - xxxx = don't care |
| whismanoid | 0:777851395940 | 198 | typedef enum MAX5715_CMD_enum_t { |
| whismanoid | 0:777851395940 | 199 | CMD_0000_nnnn_dddd_dddd_dddd_0000_CODEn = 0x00, //!< 8'b00000000 |
| whismanoid | 0:777851395940 | 200 | CMD_0001_nnnn_0000_0000_0000_0000_LOADn = 0x10, //!< 8'b00010000 |
| whismanoid | 0:777851395940 | 201 | CMD_0010_nnnn_dddd_dddd_dddd_0000_CODEnLOADall = 0x20, //!< 8'b00100000 |
| whismanoid | 0:777851395940 | 202 | CMD_0011_nnnn_dddd_dddd_dddd_0000_CODEnLOADn = 0x30, //!< 8'b00110000 |
| whismanoid | 0:777851395940 | 203 | CMD_0100_0000_0000_dcba_0000_0000_POWERn_Normal = 0x40, //!< 8'b01000000 |
| whismanoid | 0:777851395940 | 204 | CMD_0100_0001_0000_dcba_0000_0000_POWERn_PD1k = 0x41, //!< 8'b01000001 |
| whismanoid | 0:777851395940 | 205 | CMD_0100_0010_0000_dcba_0000_0000_POWERn_PD100k = 0x42, //!< 8'b01000010 |
| whismanoid | 0:777851395940 | 206 | CMD_0100_0011_0000_dcba_0000_0000_POWERn_PDHiZ = 0x43, //!< 8'b01000011 |
| whismanoid | 0:777851395940 | 207 | CMD_0101_0000_0000_0000_0000_0000_SW_CLEAR = 0x50, //!< 8'b01010000 |
| whismanoid | 0:777851395940 | 208 | CMD_0101_0001_0000_0000_0000_0000_SW_RESET = 0x51, //!< 8'b01010001 |
| whismanoid | 0:777851395940 | 209 | CMD_0110_0000_0000_dcba_0000_0000_CONFIGn_LATCHED = 0x60, //!< 8'b01100000 |
| whismanoid | 0:777851395940 | 210 | CMD_0110_0001_0000_dcba_0000_0000_CONFIGn_TRANSPARENT = 0x61, //!< 8'b01100001 |
| whismanoid | 0:777851395940 | 211 | CMD_0110_1000_0000_0000_0000_0000_CONFIGall_LATCHED = 0x68, //!< 8'b01101000 |
| whismanoid | 0:777851395940 | 212 | CMD_0110_1001_0000_0000_0000_0000_CONFIGall_TRANSPARENT = 0x69, //!< 8'b01101001 |
| whismanoid | 0:777851395940 | 213 | CMD_0111_0000_0000_0000_0000_0000_REF_EXT = 0x70, //!< 8'b01110000 |
| whismanoid | 0:777851395940 | 214 | CMD_0111_0001_0000_0000_0000_0000_REF_2V500 = 0x71, //!< 8'b01110001 |
| whismanoid | 0:777851395940 | 215 | CMD_0111_0010_0000_0000_0000_0000_REF_2V048 = 0x72, //!< 8'b01110010 |
| whismanoid | 0:777851395940 | 216 | CMD_0111_0011_0000_0000_0000_0000_REF_4V096 = 0x73, //!< 8'b01110011 |
| whismanoid | 0:777851395940 | 217 | CMD_0111_0100_0000_0000_0000_0000_REF_AlwaysOn_EXT = 0x74, //!< 8'b01110100 |
| whismanoid | 0:777851395940 | 218 | CMD_0111_0101_0000_0000_0000_0000_REF_AlwaysOn_2V500 = 0x75, //!< 8'b01110101 |
| whismanoid | 0:777851395940 | 219 | CMD_0111_0110_0000_0000_0000_0000_REF_AlwaysOn_2V048 = 0x76, //!< 8'b01110110 |
| whismanoid | 0:777851395940 | 220 | CMD_0111_0111_0000_0000_0000_0000_REF_AlwaysOn_4V096 = 0x77, //!< 8'b01110111 |
| whismanoid | 0:777851395940 | 221 | CMD_1000_0000_dddd_dddd_dddd_0000_CODEall = 0x80, //!< 8'b10000000 |
| whismanoid | 0:777851395940 | 222 | CMD_1000_0001_0000_0000_0000_0000_LOADall = 0x81, //!< 8'b10000001 |
| whismanoid | 0:777851395940 | 223 | CMD_1000_0010_dddd_dddd_dddd_0000_CODEallLOADall = 0x82, //!< 8'b10000010 |
| whismanoid | 0:777851395940 | 224 | CMD_1000_0011_dddd_dddd_dddd_0000_CODEallLOADall = 0x83, //!< 8'b10000011 |
| whismanoid | 0:777851395940 | 225 | CMD_1001_xxxx_NOP = 0x90, //!< 8'b10010000 |
| whismanoid | 0:777851395940 | 226 | CMD_1010_xxxx_NOP = 0xa0, //!< 8'b10100000 |
| whismanoid | 0:777851395940 | 227 | CMD_1011_xxxx_NOP = 0xb0, //!< 8'b10110000 |
| whismanoid | 0:777851395940 | 228 | CMD_1100_xxxx_NOP = 0xc0, //!< 8'b11000000 |
| whismanoid | 0:777851395940 | 229 | CMD_1101_xxxx_NOP = 0xd0, //!< 8'b11010000 |
| whismanoid | 0:777851395940 | 230 | CMD_1110_xxxx_NOP = 0xe0, //!< 8'b11100000 |
| whismanoid | 0:777851395940 | 231 | CMD_1111_xxxx_NOP = 0xf0, //!< 8'b11110000 |
| whismanoid | 0:777851395940 | 232 | } MAX5715_CMD_enum_t; |
| whismanoid | 0:777851395940 | 233 | |
| whismanoid | 0:777851395940 | 234 | // CODE GENERATOR: TypedefEnum MAX5715_POWER_enum_t |
| whismanoid | 0:777851395940 | 235 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 236 | /// Argument to POWER function |
| whismanoid | 0:777851395940 | 237 | typedef enum MAX5715_POWER_enum_t { |
| whismanoid | 0:777851395940 | 238 | POWERn_Normal = 0x00, //!< 8'b00000000 |
| whismanoid | 0:777851395940 | 239 | POWERn_PD1k = 0x01, //!< 8'b00000001 |
| whismanoid | 0:777851395940 | 240 | POWERn_PD100k = 0x02, //!< 8'b00000010 |
| whismanoid | 0:777851395940 | 241 | POWERn_PDHiZ = 0x03, //!< 8'b00000011 |
| whismanoid | 0:777851395940 | 242 | } MAX5715_POWER_enum_t; |
| whismanoid | 0:777851395940 | 243 | |
| whismanoid | 0:777851395940 | 244 | // CODE GENERATOR: TypedefEnum MAX5715_REF_enum_t |
| whismanoid | 0:777851395940 | 245 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 246 | /// Argument to REF function ( external? voltage? always on? ) |
| whismanoid | 0:777851395940 | 247 | typedef enum MAX5715_REF_enum_t { |
| whismanoid | 0:777851395940 | 248 | REF_EXT = 0x00, //!< 8'b00000000 |
| whismanoid | 0:777851395940 | 249 | REF_2V500 = 0x01, //!< 8'b00000001 |
| whismanoid | 0:777851395940 | 250 | REF_2V048 = 0x02, //!< 8'b00000010 |
| whismanoid | 0:777851395940 | 251 | REF_4V096 = 0x03, //!< 8'b00000011 |
| whismanoid | 0:777851395940 | 252 | REF_AlwaysOn_EXT = 0x04, //!< 8'b00000100 |
| whismanoid | 0:777851395940 | 253 | REF_AlwaysOn_2V500 = 0x05, //!< 8'b00000101 |
| whismanoid | 0:777851395940 | 254 | REF_AlwaysOn_2V048 = 0x06, //!< 8'b00000110 |
| whismanoid | 0:777851395940 | 255 | REF_AlwaysOn_4V096 = 0x07, //!< 8'b00000111 |
| whismanoid | 0:777851395940 | 256 | } MAX5715_REF_enum_t; |
| whismanoid | 0:777851395940 | 257 | |
| whismanoid | 0:777851395940 | 258 | // TODO1: CODE GENERATOR: ic_variant -- IC's supported with this driver |
| whismanoid | 0:777851395940 | 259 | /** |
| whismanoid | 0:777851395940 | 260 | * @brief IC's supported with this driver |
| whismanoid | 0:777851395940 | 261 | * @details MAX5715 |
| whismanoid | 0:777851395940 | 262 | */ |
| whismanoid | 0:777851395940 | 263 | typedef enum |
| whismanoid | 0:777851395940 | 264 | { |
| whismanoid | 0:777851395940 | 265 | MAX5715_IC = 0, |
| whismanoid | 0:777851395940 | 266 | //MAX5715_IC = 1 |
| whismanoid | 0:777851395940 | 267 | } MAX5715_ic_t; |
| whismanoid | 0:777851395940 | 268 | |
| whismanoid | 0:777851395940 | 269 | // TODO1: CODE GENERATOR: class constructor declaration |
| whismanoid | 0:777851395940 | 270 | /**********************************************************//** |
| whismanoid | 0:777851395940 | 271 | * @brief Constructor for MAX5715 Class. |
| whismanoid | 0:777851395940 | 272 | * |
| whismanoid | 0:777851395940 | 273 | * @details Requires an existing SPI object as well as a DigitalOut object. |
| whismanoid | 0:777851395940 | 274 | * The DigitalOut object is used for a chip enable signal |
| whismanoid | 0:777851395940 | 275 | * |
| whismanoid | 0:777851395940 | 276 | * On Entry: |
| whismanoid | 0:777851395940 | 277 | * @param[in] spi - pointer to existing SPI object |
| whismanoid | 0:777851395940 | 278 | * @param[in] cs_pin - pointer to a DigitalOut pin object |
| whismanoid | 0:777851395940 | 279 | * CODE GENERATOR: class constructor docstrings gpio InputPin pins |
| whismanoid | 0:777851395940 | 280 | * @param[in] LDACb_pin - pointer to a DigitalOut pin object |
| whismanoid | 0:777851395940 | 281 | * @param[in] CLRb_pin - pointer to a DigitalOut pin object |
| whismanoid | 0:777851395940 | 282 | * CODE GENERATOR: class constructor docstrings gpio OutputPin pins |
| whismanoid | 0:777851395940 | 283 | * @param[in] ic_variant - which type of MAX5715 is used |
| whismanoid | 0:777851395940 | 284 | * |
| whismanoid | 0:777851395940 | 285 | * On Exit: |
| whismanoid | 0:777851395940 | 286 | * |
| whismanoid | 0:777851395940 | 287 | * @return None |
| whismanoid | 0:777851395940 | 288 | **************************************************************/ |
| whismanoid | 0:777851395940 | 289 | MAX5715(SPI &spi, DigitalOut &cs_pin, // SPI interface |
| whismanoid | 0:777851395940 | 290 | // CODE GENERATOR: class constructor declaration gpio InputPin pins |
| whismanoid | 0:777851395940 | 291 | DigitalOut &LDACb_pin, // Digital Trigger Input to MAX5715 device |
| whismanoid | 0:777851395940 | 292 | DigitalOut &CLRb_pin, // Digital Trigger Input to MAX5715 device |
| whismanoid | 0:777851395940 | 293 | // AnalogOut &REF_pin, // Reference Input to MAX5715 device |
| whismanoid | 0:777851395940 | 294 | // CODE GENERATOR: class constructor declaration gpio OutputPin pins |
| whismanoid | 0:777851395940 | 295 | // AnalogIn &OUTA_pin, // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 296 | // AnalogIn &OUTB_pin, // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 297 | // AnalogIn &OUTC_pin, // Analog Output from MAX5715 device |
| whismanoid | 0:777851395940 | 298 | // AnalogIn &OUTD_pin, // Analog Output from MAX5715 device |
| whismanoid | 3:a3f0518094f4 | 299 | // DigitalIn &RDYb_pin, // Digital DaisyChain Output from MAX5715 device |
| whismanoid | 0:777851395940 | 300 | MAX5715_ic_t ic_variant); |
| whismanoid | 0:777851395940 | 301 | |
| whismanoid | 0:777851395940 | 302 | // CODE GENERATOR: class destructor declaration |
| whismanoid | 0:777851395940 | 303 | /************************************************************ |
| whismanoid | 0:777851395940 | 304 | * @brief Default destructor for MAX5715 Class. |
| whismanoid | 0:777851395940 | 305 | * |
| whismanoid | 0:777851395940 | 306 | * @details Destroys SPI object if owner |
| whismanoid | 0:777851395940 | 307 | * |
| whismanoid | 0:777851395940 | 308 | * On Entry: |
| whismanoid | 0:777851395940 | 309 | * |
| whismanoid | 0:777851395940 | 310 | * On Exit: |
| whismanoid | 0:777851395940 | 311 | * |
| whismanoid | 0:777851395940 | 312 | * @return None |
| whismanoid | 0:777851395940 | 313 | **************************************************************/ |
| whismanoid | 0:777851395940 | 314 | ~MAX5715(); |
| whismanoid | 0:777851395940 | 315 | |
| whismanoid | 0:777851395940 | 316 | // CODE GENERATOR: spi_frequency setter declaration |
| whismanoid | 3:a3f0518094f4 | 317 | /// set SPI SCLK frequency |
| whismanoid | 0:777851395940 | 318 | void spi_frequency(int spi_sclk_Hz); |
| whismanoid | 0:777851395940 | 319 | |
| whismanoid | 0:777851395940 | 320 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 321 | // CODE GENERATOR: omit typedef enum MAX5715_device_t, class members instead of global device object |
| whismanoid | 0:777851395940 | 322 | public: |
| whismanoid | 0:777851395940 | 323 | |
| whismanoid | 0:777851395940 | 324 | /// reference voltage, in Volts |
| whismanoid | 0:777851395940 | 325 | double VRef; |
| whismanoid | 0:777851395940 | 326 | |
| whismanoid | 0:777851395940 | 327 | /// DAC Selection: 0=OUTA, 1=OUTB, 2=OUTC, 3=OUTD, 4..15=ALL OUTA,OUTB,OUTC,OUTD |
| whismanoid | 0:777851395940 | 328 | uint8_t channelNumber_0_3; |
| whismanoid | 0:777851395940 | 329 | |
| whismanoid | 0:777851395940 | 330 | /// channel bitmask channel_dcba: 1=OUTA, 2=OUTB, 4=OUTC, 8=OUTD |
| whismanoid | 0:777851395940 | 331 | uint8_t channels_bitmask_DCBA; |
| whismanoid | 0:777851395940 | 332 | |
| whismanoid | 0:777851395940 | 333 | /// shadow of write-only register CODE[channel_0_3] CMD_0010_nnnn |
| whismanoid | 0:777851395940 | 334 | int16_t Shadow_0010_nnnn_CODE[4]; |
| whismanoid | 0:777851395940 | 335 | |
| whismanoid | 0:777851395940 | 336 | /// shadow of write-only register POWER[channel_0_3] CMD_0100_00pp |
| whismanoid | 0:777851395940 | 337 | int16_t Shadow_0100_00pp_POWER[4]; |
| whismanoid | 0:777851395940 | 338 | |
| whismanoid | 0:777851395940 | 339 | /// shadow of write-only register CONFIG[channel_0_3] CMD_0110_a00t |
| whismanoid | 0:777851395940 | 340 | int16_t Shadow_0110_a00t_CONFIG[4]; |
| whismanoid | 0:777851395940 | 341 | |
| whismanoid | 0:777851395940 | 342 | /// shadow of write-only register REF CMD_0111_0rrr |
| whismanoid | 0:777851395940 | 343 | int16_t Shadow_0111_0rrr_REF; |
| whismanoid | 0:777851395940 | 344 | |
| whismanoid | 0:777851395940 | 345 | /// shadow of CODE field of write-only register CODE[channel_0_3] CMD_0010_nnnn |
| whismanoid | 0:777851395940 | 346 | int16_t CODE[4]; |
| whismanoid | 0:777851395940 | 347 | |
| whismanoid | 0:777851395940 | 348 | // CODE GENERATOR: omit global g_MAX5715_device |
| whismanoid | 0:777851395940 | 349 | |
| whismanoid | 0:777851395940 | 350 | // CODE GENERATOR: extern function declarations |
| whismanoid | 0:777851395940 | 351 | // CODE GENERATOR: extern function declaration SPIoutputCS |
| whismanoid | 0:777851395940 | 352 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 353 | // Assert SPI Chip Select |
| whismanoid | 0:777851395940 | 354 | // SPI chip-select for MAX5715 |
| whismanoid | 0:777851395940 | 355 | // |
| whismanoid | 0:777851395940 | 356 | void SPIoutputCS(int isLogicHigh); |
| whismanoid | 0:777851395940 | 357 | |
| whismanoid | 0:777851395940 | 358 | // CODE GENERATOR: extern function declaration SPIwrite24bits |
| whismanoid | 0:777851395940 | 359 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 360 | // SPI write 24 bits |
| whismanoid | 0:777851395940 | 361 | // SPI interface to MAX5715 shift 24 bits mosiData into MAX5715 DIN |
| whismanoid | 0:777851395940 | 362 | // |
| whismanoid | 0:777851395940 | 363 | void SPIwrite24bits(int8_t mosiData8_FF0000, int16_t mosiData16_00FFFF); |
| whismanoid | 0:777851395940 | 364 | |
| whismanoid | 0:777851395940 | 365 | // CODE GENERATOR: extern function declaration LDACboutputValue |
| whismanoid | 0:777851395940 | 366 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 367 | // Assert MAX5715 LDAC pin : High = inactive, Low = load DAC. |
| whismanoid | 0:777851395940 | 368 | // |
| whismanoid | 0:777851395940 | 369 | void LDACboutputValue(int isLogicHigh); |
| whismanoid | 0:777851395940 | 370 | |
| whismanoid | 0:777851395940 | 371 | // CODE GENERATOR: extern function declaration CLRboutputValue |
| whismanoid | 0:777851395940 | 372 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 373 | // Assert MAX5715 CLR pin : High = inactive, Low = clear DAC. |
| whismanoid | 0:777851395940 | 374 | // |
| whismanoid | 0:777851395940 | 375 | void CLRboutputValue(int isLogicHigh); |
| whismanoid | 0:777851395940 | 376 | |
| whismanoid | 0:777851395940 | 377 | // CODE GENERATOR: class member data |
| whismanoid | 0:777851395940 | 378 | private: |
| whismanoid | 0:777851395940 | 379 | // CODE GENERATOR: class member data for SPI interface |
| whismanoid | 0:777851395940 | 380 | // SPI object |
| whismanoid | 0:777851395940 | 381 | SPI &m_spi; |
| whismanoid | 0:777851395940 | 382 | int m_SPI_SCLK_Hz; |
| whismanoid | 0:777851395940 | 383 | int m_SPI_dataMode; |
| whismanoid | 0:777851395940 | 384 | int m_SPI_cs_state; |
| whismanoid | 0:777851395940 | 385 | |
| whismanoid | 0:777851395940 | 386 | // Selector pin object |
| whismanoid | 0:777851395940 | 387 | DigitalOut &m_cs_pin; |
| whismanoid | 0:777851395940 | 388 | |
| whismanoid | 0:777851395940 | 389 | // CODE GENERATOR: class member data for gpio InputPin pins |
| whismanoid | 0:777851395940 | 390 | // InputPin Name = LDAC# |
| whismanoid | 0:777851395940 | 391 | // InputPin Description = Dedicated Active-Low Asynchronous Load DAC. |
| whismanoid | 0:777851395940 | 392 | // InputPin Function = Trigger |
| whismanoid | 0:777851395940 | 393 | DigitalOut &m_LDACb_pin; |
| whismanoid | 0:777851395940 | 394 | // |
| whismanoid | 0:777851395940 | 395 | // InputPin Name = CLR# |
| whismanoid | 0:777851395940 | 396 | // InputPin Description = Active-Low Clear Input. |
| whismanoid | 0:777851395940 | 397 | // InputPin Function = Trigger |
| whismanoid | 0:777851395940 | 398 | DigitalOut &m_CLRb_pin; |
| whismanoid | 0:777851395940 | 399 | // |
| whismanoid | 0:777851395940 | 400 | // InputPin Name = REF |
| whismanoid | 0:777851395940 | 401 | // InputPin Description = Reference Voltage Input/Output. |
| whismanoid | 0:777851395940 | 402 | // Software selectable to be external reference or internal 2.048V, 2.500V, or 4.096V reference. |
| whismanoid | 0:777851395940 | 403 | // Default is external reference mode. |
| whismanoid | 0:777851395940 | 404 | // InputPin Function = Reference |
| whismanoid | 0:777851395940 | 405 | // AnalogOut &m_REF_pin; |
| whismanoid | 0:777851395940 | 406 | // |
| whismanoid | 0:777851395940 | 407 | // CODE GENERATOR: class member data for gpio OutputPin pins |
| whismanoid | 0:777851395940 | 408 | // OutputPin Name = OUTA |
| whismanoid | 0:777851395940 | 409 | // OutputPin Description = Buffered Channel A DAC Output |
| whismanoid | 0:777851395940 | 410 | // OutputPin Function = Analog |
| whismanoid | 0:777851395940 | 411 | // AnalogIn &m_OUTA_pin; |
| whismanoid | 0:777851395940 | 412 | // |
| whismanoid | 0:777851395940 | 413 | // OutputPin Name = OUTB |
| whismanoid | 0:777851395940 | 414 | // OutputPin Description = Buffered Channel B DAC Output |
| whismanoid | 0:777851395940 | 415 | // OutputPin Function = Analog |
| whismanoid | 0:777851395940 | 416 | // AnalogIn &m_OUTB_pin; |
| whismanoid | 0:777851395940 | 417 | // |
| whismanoid | 0:777851395940 | 418 | // OutputPin Name = OUTC |
| whismanoid | 0:777851395940 | 419 | // OutputPin Description = Buffered Channel C DAC Output |
| whismanoid | 0:777851395940 | 420 | // OutputPin Function = Analog |
| whismanoid | 0:777851395940 | 421 | // AnalogIn &m_OUTC_pin; |
| whismanoid | 0:777851395940 | 422 | // |
| whismanoid | 0:777851395940 | 423 | // OutputPin Name = OUTD |
| whismanoid | 0:777851395940 | 424 | // OutputPin Description = Buffered Channel D DAC Output |
| whismanoid | 0:777851395940 | 425 | // OutputPin Function = Analog |
| whismanoid | 0:777851395940 | 426 | // AnalogIn &m_OUTD_pin; |
| whismanoid | 0:777851395940 | 427 | // |
| whismanoid | 0:777851395940 | 428 | // OutputPin Name = RDY# |
| whismanoid | 0:777851395940 | 429 | // OutputPin Description = SPI RDY Output. In daisy-chained applications connect RDY to the CSB of the next device in the chain. |
| whismanoid | 0:777851395940 | 430 | // OutputPin Function = DaisyChain |
| whismanoid | 0:777851395940 | 431 | // DigitalIn &m_RDYb_pin; |
| whismanoid | 0:777851395940 | 432 | // |
| whismanoid | 0:777851395940 | 433 | |
| whismanoid | 0:777851395940 | 434 | // Identifies which IC variant is being used |
| whismanoid | 0:777851395940 | 435 | MAX5715_ic_t m_ic_variant; |
| whismanoid | 0:777851395940 | 436 | |
| whismanoid | 0:777851395940 | 437 | public: |
| whismanoid | 0:777851395940 | 438 | |
| whismanoid | 0:777851395940 | 439 | // CODE GENERATOR: class member function declarations |
| whismanoid | 0:777851395940 | 440 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 441 | /// Initialize device |
| whismanoid | 0:777851395940 | 442 | /// @return 1 on success; 0 on failure |
| whismanoid | 0:777851395940 | 443 | uint8_t Init(void); |
| whismanoid | 0:777851395940 | 444 | |
| whismanoid | 0:777851395940 | 445 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 446 | /// Return the DAC register value corresponding to physical voltage. |
| whismanoid | 0:777851395940 | 447 | /// Does not perform any offset or gain correction. |
| whismanoid | 0:777851395940 | 448 | /// |
| whismanoid | 0:777851395940 | 449 | /// @pre g_MAX5715_device.VRef = Voltage of REF input, in Volts |
| whismanoid | 0:777851395940 | 450 | /// @param[in] voltage = physical voltage in Volts |
| whismanoid | 0:777851395940 | 451 | /// @return raw 12-bit MAX5715 code (right justified). |
| whismanoid | 0:777851395940 | 452 | uint16_t DACCodeOfVoltage(double voltageV); |
| whismanoid | 0:777851395940 | 453 | |
| whismanoid | 0:777851395940 | 454 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 455 | /// Return the physical voltage corresponding to DAC register. |
| whismanoid | 0:777851395940 | 456 | /// Does not perform any offset or gain correction. |
| whismanoid | 0:777851395940 | 457 | /// |
| whismanoid | 0:777851395940 | 458 | /// @pre g_MAX5715_device.VRef = Voltage of REF input, in Volts |
| whismanoid | 0:777851395940 | 459 | /// @param[in] value_u12: raw 12-bit MAX5715 code (right justified). |
| whismanoid | 0:777851395940 | 460 | /// @return physical voltage corresponding to MAX5715 code. |
| whismanoid | 0:777851395940 | 461 | double VoltageOfCode(uint16_t value_u12); |
| whismanoid | 0:777851395940 | 462 | |
| whismanoid | 0:777851395940 | 463 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 464 | /// CMD_1000_0000_dddd_dddd_dddd_0000_CODEall |
| whismanoid | 0:777851395940 | 465 | /// |
| whismanoid | 0:777851395940 | 466 | /// Writes data to all CODE registers |
| whismanoid | 0:777851395940 | 467 | /// @post updates g_MAX5815_device.Shadow_0010_nnnn_CODE[0..3] |
| whismanoid | 0:777851395940 | 468 | /// @post updates g_MAX5815_device.CODE[0..3] |
| whismanoid | 0:777851395940 | 469 | void CODEall(uint16_t dacCodeLsbs); |
| whismanoid | 0:777851395940 | 470 | |
| whismanoid | 0:777851395940 | 471 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 472 | /// CMD_0000_nnnn_dddd_dddd_dddd_0000_CODEn |
| whismanoid | 0:777851395940 | 473 | /// |
| whismanoid | 0:777851395940 | 474 | /// Writes data to the selected CODE register(s) |
| whismanoid | 0:777851395940 | 475 | /// |
| whismanoid | 0:777851395940 | 476 | /// @param[in] channel_0_3 = DAC Selection: 0=OUTA, 1=OUTB, 2=OUTC, 3=OUTD, 4..15=ALL OUTA,OUTB,OUTC,OUTD |
| whismanoid | 0:777851395940 | 477 | /// @post updates g_MAX5815_device.Shadow_0010_nnnn_CODE[0..3] |
| whismanoid | 0:777851395940 | 478 | /// @post updates g_MAX5815_device.CODE[0..3] |
| whismanoid | 0:777851395940 | 479 | void CODEn(uint8_t channel_0_3, uint16_t dacCodeLsbs); |
| whismanoid | 0:777851395940 | 480 | |
| whismanoid | 0:777851395940 | 481 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 482 | /// CMD_1000_0010_dddd_dddd_dddd_0000_CODEallLOADall |
| whismanoid | 0:777851395940 | 483 | /// |
| whismanoid | 0:777851395940 | 484 | /// Simultaneously writes data to all CODE registers while updating all DAC registers |
| whismanoid | 0:777851395940 | 485 | /// @post updates g_MAX5815_device.Shadow_0010_nnnn_CODE[0..3] |
| whismanoid | 0:777851395940 | 486 | /// @post updates g_MAX5815_device.CODE[0..3] |
| whismanoid | 0:777851395940 | 487 | void CODEallLOADall(uint16_t dacCodeLsbs); |
| whismanoid | 0:777851395940 | 488 | |
| whismanoid | 0:777851395940 | 489 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 490 | /// CMD_0010_nnnn_dddd_dddd_dddd_0000_CODEnLOADall |
| whismanoid | 0:777851395940 | 491 | /// |
| whismanoid | 0:777851395940 | 492 | /// Simultaneously writes data to the selected CODE register(s) while updating all DAC registers. |
| whismanoid | 0:777851395940 | 493 | /// |
| whismanoid | 0:777851395940 | 494 | /// @param[in] channel_0_3 = DAC Selection: 0=OUTA, 1=OUTB, 2=OUTC, 3=OUTD, 4..15=ALL OUTA,OUTB,OUTC,OUTD |
| whismanoid | 0:777851395940 | 495 | /// @post updates g_MAX5815_device.Shadow_0010_nnnn_CODE[0..3] |
| whismanoid | 0:777851395940 | 496 | /// @post updates g_MAX5815_device.CODE[0..3] |
| whismanoid | 0:777851395940 | 497 | void CODEnLOADall(uint8_t channel_0_3, uint16_t dacCodeLsbs); |
| whismanoid | 0:777851395940 | 498 | |
| whismanoid | 0:777851395940 | 499 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 500 | /// CMD_0011_nnnn_dddd_dddd_dddd_0000_CODEnLOADn |
| whismanoid | 0:777851395940 | 501 | /// |
| whismanoid | 0:777851395940 | 502 | /// Simultaneously writes data to the selected CODE register(s) while updating selected DAC register(s) |
| whismanoid | 0:777851395940 | 503 | /// |
| whismanoid | 0:777851395940 | 504 | /// @param[in] channel_0_3 = DAC Selection: 0=OUTA, 1=OUTB, 2=OUTC, 3=OUTD, 4..15=ALL OUTA,OUTB,OUTC,OUTD |
| whismanoid | 0:777851395940 | 505 | /// @post updates g_MAX5815_device.Shadow_0010_nnnn_CODE[0..3] |
| whismanoid | 0:777851395940 | 506 | /// @post updates g_MAX5815_device.CODE[0..3] |
| whismanoid | 0:777851395940 | 507 | void CODEnLOADn(uint8_t channel_0_3, uint16_t dacCodeLsbs); |
| whismanoid | 0:777851395940 | 508 | |
| whismanoid | 0:777851395940 | 509 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 510 | /// CMD_0110_0000_0000_dcba_0000_0000_CONFIGn_LATCHED |
| whismanoid | 0:777851395940 | 511 | /// |
| whismanoid | 0:777851395940 | 512 | /// Sets the DAC Latch Mode of the selected DACs. |
| whismanoid | 0:777851395940 | 513 | /// Only DACS with a 1 in the selection bit are updated by the command. |
| whismanoid | 0:777851395940 | 514 | /// LD_EN = 0: DAC latch is operational (LOAD and LDAC controlled) |
| whismanoid | 0:777851395940 | 515 | /// |
| whismanoid | 0:777851395940 | 516 | /// @param[in] channels_bitmask_DCBA = channel select bitmap |
| whismanoid | 0:777851395940 | 517 | /// bit 1000 = channel D |
| whismanoid | 0:777851395940 | 518 | /// bit 0100 = channel C |
| whismanoid | 0:777851395940 | 519 | /// bit 0010 = channel B |
| whismanoid | 0:777851395940 | 520 | /// bit 0001 = channel A |
| whismanoid | 0:777851395940 | 521 | void CONFIGn_LATCHED(uint8_t channels_bitmask_DCBA); |
| whismanoid | 0:777851395940 | 522 | |
| whismanoid | 0:777851395940 | 523 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 524 | /// CMD_0110_0001_0000_dcba_0000_0000_CONFIGn_TRANSPARENT |
| whismanoid | 0:777851395940 | 525 | /// |
| whismanoid | 0:777851395940 | 526 | /// Sets the DAC Latch Mode of the selected DACs. |
| whismanoid | 0:777851395940 | 527 | /// Only DACS with a 1 in the selection bit are updated by the command. |
| whismanoid | 0:777851395940 | 528 | /// LD_EN = 1: DAC latch is transparent |
| whismanoid | 0:777851395940 | 529 | /// |
| whismanoid | 0:777851395940 | 530 | /// @param[in] channels_bitmask_DCBA = channel select bitmap |
| whismanoid | 0:777851395940 | 531 | /// bit 1000 = channel D |
| whismanoid | 0:777851395940 | 532 | /// bit 0100 = channel C |
| whismanoid | 0:777851395940 | 533 | /// bit 0010 = channel B |
| whismanoid | 0:777851395940 | 534 | /// bit 0001 = channel A |
| whismanoid | 0:777851395940 | 535 | void CONFIGn_TRANSPARENT(uint8_t channels_bitmask_DCBA); |
| whismanoid | 0:777851395940 | 536 | |
| whismanoid | 0:777851395940 | 537 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 538 | /// CMD_0110_1000_0000_0000_0000_0000_CONFIGall_LATCHED |
| whismanoid | 0:777851395940 | 539 | /// |
| whismanoid | 0:777851395940 | 540 | /// Sets the DAC Latch Mode of all DACs. |
| whismanoid | 0:777851395940 | 541 | /// LD_EN = 0: DAC latch is operational (LOAD and LDAC controlled) |
| whismanoid | 0:777851395940 | 542 | void CONFIGall_LATCHED(void); |
| whismanoid | 0:777851395940 | 543 | |
| whismanoid | 0:777851395940 | 544 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 545 | /// CMD_0110_1001_0000_0000_0000_0000_CONFIGall_TRANSPARENT |
| whismanoid | 0:777851395940 | 546 | /// |
| whismanoid | 0:777851395940 | 547 | /// Sets the DAC Latch Mode of all DACs. |
| whismanoid | 0:777851395940 | 548 | /// LD_EN = 1: DAC latch is transparent |
| whismanoid | 0:777851395940 | 549 | void CONFIGall_TRANSPARENT(void); |
| whismanoid | 0:777851395940 | 550 | |
| whismanoid | 0:777851395940 | 551 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 552 | /// CMD_1000_0001_0000_0000_0000_0000_LOADall |
| whismanoid | 0:777851395940 | 553 | /// |
| whismanoid | 0:777851395940 | 554 | /// Updates all DAC latches with current CODE register data |
| whismanoid | 0:777851395940 | 555 | void LOADall(void); |
| whismanoid | 0:777851395940 | 556 | |
| whismanoid | 0:777851395940 | 557 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 558 | /// CMD_0001_nnnn_0000_0000_0000_0000_LOADn |
| whismanoid | 0:777851395940 | 559 | /// |
| whismanoid | 0:777851395940 | 560 | /// Transfers data from the selected CODE register(s) to the selected DAC register(s). |
| whismanoid | 0:777851395940 | 561 | /// |
| whismanoid | 0:777851395940 | 562 | /// @param[in] channel_0_3 = DAC Selection: 0=OUTA, 1=OUTB, 2=OUTC, 3=OUTD, 4..15=ALL OUTA,OUTB,OUTC,OUTD |
| whismanoid | 0:777851395940 | 563 | void LOADn(uint8_t channel_0_3); |
| whismanoid | 0:777851395940 | 564 | |
| whismanoid | 0:777851395940 | 565 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 566 | /// CMD_0100_0000_0000_dcba_0000_0000_POWERn_Normal |
| whismanoid | 3:a3f0518094f4 | 567 | /// CMD_0100_0001_0000_dcba_0000_0000_POWERn_PD1k |
| whismanoid | 3:a3f0518094f4 | 568 | /// CMD_0100_0010_0000_dcba_0000_0000_POWERn_PD100k |
| whismanoid | 3:a3f0518094f4 | 569 | /// CMD_0100_0011_0000_dcba_0000_0000_POWERn_PDHiZ |
| whismanoid | 0:777851395940 | 570 | /// |
| whismanoid | 0:777851395940 | 571 | /// Sets the power mode of the selected DACs |
| whismanoid | 0:777851395940 | 572 | /// (DACs selected with a 1 in the corresponding DACn bit are updated, |
| whismanoid | 0:777851395940 | 573 | /// DACs with a 0 in the corresponding DACn bit are not impacted) |
| whismanoid | 0:777851395940 | 574 | /// |
| whismanoid | 0:777851395940 | 575 | /// @param[in] channels_bitmask_DCBA = channel select bitmap |
| whismanoid | 0:777851395940 | 576 | /// bit 1000 = channel D |
| whismanoid | 0:777851395940 | 577 | /// bit 0100 = channel C |
| whismanoid | 0:777851395940 | 578 | /// bit 0010 = channel B |
| whismanoid | 0:777851395940 | 579 | /// bit 0001 = channel A |
| whismanoid | 0:777851395940 | 580 | /// @param[in] powerValue = power configuration for selected channel |
| whismanoid | 0:777851395940 | 581 | void POWER(uint8_t channels_bitmask_DCBA, MAX5715_POWER_enum_t powerValue); |
| whismanoid | 0:777851395940 | 582 | |
| whismanoid | 0:777851395940 | 583 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 584 | /// CMD_0111_0000_0000_0000_0000_0000_REF_EXT |
| whismanoid | 0:777851395940 | 585 | /// CMD_0111_0001_0000_0000_0000_0000_REF_2V500 |
| whismanoid | 0:777851395940 | 586 | /// CMD_0111_0010_0000_0000_0000_0000_REF_2V048 |
| whismanoid | 0:777851395940 | 587 | /// CMD_0111_0011_0000_0000_0000_0000_REF_4V096 |
| whismanoid | 0:777851395940 | 588 | /// CMD_0111_0100_0000_0000_0000_0000_REF_AlwaysOn_EXT |
| whismanoid | 0:777851395940 | 589 | /// CMD_0111_0101_0000_0000_0000_0000_REF_AlwaysOn_2V500 |
| whismanoid | 0:777851395940 | 590 | /// CMD_0111_0110_0000_0000_0000_0000_REF_AlwaysOn_2V048 |
| whismanoid | 0:777851395940 | 591 | /// CMD_0111_0111_0000_0000_0000_0000_REF_AlwaysOn_4V096 |
| whismanoid | 0:777851395940 | 592 | /// |
| whismanoid | 0:777851395940 | 593 | /// Sets the reference operating mode. |
| whismanoid | 0:777851395940 | 594 | /// REF Power (B18): 0 = Internal reference is only powered if at least one DAC is powered |
| whismanoid | 0:777851395940 | 595 | /// 1 = Internal reference is always powered |
| whismanoid | 0:777851395940 | 596 | void REF(MAX5715_REF_enum_t value); |
| whismanoid | 0:777851395940 | 597 | |
| whismanoid | 0:777851395940 | 598 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 599 | /// CMD_0101_0000_0000_0000_0000_0000_SW_CLEAR |
| whismanoid | 0:777851395940 | 600 | /// |
| whismanoid | 0:777851395940 | 601 | /// Software Clear |
| whismanoid | 0:777851395940 | 602 | /// All CODE and DAC registers cleared to their default values. |
| whismanoid | 0:777851395940 | 603 | /// |
| whismanoid | 0:777851395940 | 604 | /// @return 1 on success; 0 on failure |
| whismanoid | 0:777851395940 | 605 | uint8_t SW_CLEAR(void); |
| whismanoid | 0:777851395940 | 606 | |
| whismanoid | 0:777851395940 | 607 | //---------------------------------------- |
| whismanoid | 0:777851395940 | 608 | /// CMD_0101_0001_0000_0000_0000_0000_SW_RESET |
| whismanoid | 0:777851395940 | 609 | /// |
| whismanoid | 0:777851395940 | 610 | /// Software Reset |
| whismanoid | 0:777851395940 | 611 | /// All CODE, DAC, and control registers returned to their default values, |
| whismanoid | 0:777851395940 | 612 | /// simulating a power cycle reset. |
| whismanoid | 0:777851395940 | 613 | /// |
| whismanoid | 0:777851395940 | 614 | /// @return 1 on success; 0 on failure |
| whismanoid | 0:777851395940 | 615 | uint8_t SW_RESET(void); |
| whismanoid | 0:777851395940 | 616 | |
| whismanoid | 0:777851395940 | 617 | }; // end of class MAX5715 |
| whismanoid | 0:777851395940 | 618 | |
| whismanoid | 0:777851395940 | 619 | #endif // __MAX5715_H__ |
| whismanoid | 0:777851395940 | 620 | |
| whismanoid | 0:777851395940 | 621 | // End of file |
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 05 Jun 2019 |
| Imports: | 12 |
| Forks: | 0 |
| Commits: | 8 |
| Dependents: | 3 |
| Dependencies: | 0 |
| Followers: | 110 |
The code in this repository is Apache licensed.
Components
MAX5715BOB