File content as of revision 5:e8c0dfaeb53b:

// /*******************************************************************************
// * Copyright (C) 2020 Maxim Integrated Products, Inc., All Rights Reserved.
// *
// * Permission is hereby granted, free of charge, to any person obtaining a
// * copy of this software and associated documentation files (the "Software"),
// * to deal in the Software without restriction, including without limitation
// * the rights to use, copy, modify, merge, publish, distribute, sublicense,
// * and/or sell copies of the Software, and to permit persons to whom the
// * Software is furnished to do so, subject to the following conditions:
// *
// * The above copyright notice and this permission notice shall be included
// * in all copies or substantial portions of the Software.
// *
// * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
// * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// * OTHER DEALINGS IN THE SOFTWARE.
// *
// * Except as contained in this notice, the name of Maxim Integrated
// * Products, Inc. shall not be used except as stated in the Maxim Integrated
// * Products, Inc. Branding Policy.
// *
// * The mere transfer of this software does not imply any licenses
// * of trade secrets, proprietary technology, copyrights, patents,
// * trademarks, maskwork rights, or any other form of intellectual
// * property whatsoever. Maxim Integrated Products, Inc. retains all
// * ownership rights.
// *******************************************************************************
// */
// *********************************************************************
// @file MAX5171.h
// *********************************************************************
// Header file
// DO NOT EDIT; except areas designated "CUSTOMIZE". Automatically generated file.
// generated by XMLSystemOfDevicesToMBED.py
// System Name = ExampleSystem
// System Description = Device driver example
// Device Name = MAX5171
// Device Description = Low-Power, Serial, 14-Bit, 1-Channel DACs with Force/Sense Voltage Output and SPI Interface
// Device DeviceBriefDescription = 14-bit Force/Sense DAC
// Device Manufacturer = Maxim Integrated
// Device PartNumber = MAX5171AEEE+
// Device RegValue_Width = DataWidth16bit_HL
//
// DAC NumChannels = 1
// DAC ResolutionBits = 14
//
// SPI CS = ActiveLow
// SPI FrameStart = CS
// SPI CPOL = 0
// SPI CPHA = 0
// SPI MOSI and MISO Data are both stable on Rising edge of SCLK
// SPI SCLK Idle Low
// SPI SCLKMaxMHz = 10
// SPI SCLKMinMHz = 0
//


// Prevent multiple declaration
#ifndef __MAX5171_H__
#define __MAX5171_H__

// standard include for target platform -- Platform_Include_Boilerplate
#include "mbed.h"
// Platforms:
//   - MAX32625MBED
//      - supports mbed-os-5.11, requires USBDevice library
//      - add https://developer.mbed.org/teams/MaximIntegrated/code/USBDevice/
//      - remove max32630fthr library (if present)
//      - remove MAX32620FTHR library (if present)
//   - MAX32600MBED
//      - remove max32630fthr library (if present)
//      - remove MAX32620FTHR library (if present)
//      - Windows 10 note:  Don't connect HDK until you are ready to load new firmware into the board.
//   - NUCLEO_F446RE
//      - remove USBDevice library
//      - remove max32630fthr library (if present)
//      - remove MAX32620FTHR library (if present)
//   - NUCLEO_F401RE
//      - remove USBDevice library
//      - remove max32630fthr library (if present)
//      - remove MAX32620FTHR library (if present)
//   - MAX32630FTHR
//      - #include "max32630fthr.h"
//      - add http://os.mbed.org/teams/MaximIntegrated/code/max32630fthr/
//      - remove MAX32620FTHR library (if present)
//   - MAX32620FTHR
//      - #include "MAX32620FTHR.h"
//      - remove max32630fthr library (if present)
//      - add https://os.mbed.com/teams/MaximIntegrated/code/MAX32620FTHR/
//      - not tested yet
//   - MAX32625PICO
//      - remove max32630fthr library (if present)
//      - remove MAX32620FTHR library (if present)
//      - not tested yet
//
// end Platform_Include_Boilerplate

/**
 * @brief MAX5171 Low-Power, Serial, 14-Bit, 1-Channel DACs with Force/Sense Voltage Output and SPI Interface
 *
 *
 *
 * Datasheet: https://www.maximintegrated.com/MAX5171
 *
 *
 *
 * @code
 * // example code includes
 * // standard include for target platform -- Platform_Include_Boilerplate
 * #include "mbed.h"
 * // Platforms:
 * //   - MAX32625MBED
 * //      - supports mbed-os-5.11, requires USBDevice library
 * //      - add https://developer.mbed.org/teams/MaximIntegrated/code/USBDevice/
 * //      - remove max32630fthr library (if present)
 * //      - remove MAX32620FTHR library (if present)
 * //   - MAX32600MBED
 * //      - remove max32630fthr library (if present)
 * //      - remove MAX32620FTHR library (if present)
 * //      - Windows 10 note:  Don't connect HDK until you are ready to load new firmware into the board.
 * //   - NUCLEO_F446RE
 * //      - remove USBDevice library
 * //      - remove max32630fthr library (if present)
 * //      - remove MAX32620FTHR library (if present)
 * //   - NUCLEO_F401RE
 * //      - remove USBDevice library
 * //      - remove max32630fthr library (if present)
 * //      - remove MAX32620FTHR library (if present)
 * //   - MAX32630FTHR
 * //      - #include "max32630fthr.h"
 * //      - add http://os.mbed.org/teams/MaximIntegrated/code/max32630fthr/
 * //      - remove MAX32620FTHR library (if present)
 * //   - MAX32620FTHR
 * //      - #include "MAX32620FTHR.h"
 * //      - remove max32630fthr library (if present)
 * //      - add https://os.mbed.com/teams/MaximIntegrated/code/MAX32620FTHR/
 * //      - not tested yet
 * //   - MAX32625PICO
 * //      - remove max32630fthr library (if present)
 * //      - remove MAX32620FTHR library (if present)
 * //      - not tested yet
 * //
 * // end Platform_Include_Boilerplate
 * #include "MAX5171.h"
 *
 * // example code board support
 * //MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);
 * //DigitalOut rLED(LED1);
 * //DigitalOut gLED(LED2);
 * //DigitalOut bLED(LED3);
 * //
 * // Arduino "shield" connector port definitions (MAX32625MBED shown)
 * #if defined(TARGET_MAX32625MBED)
 * #define A0 AIN_0
 * #define A1 AIN_1
 * #define A2 AIN_2
 * #define A3 AIN_3
 * #define D0 P0_0
 * #define D1 P0_1
 * #define D2 P0_2
 * #define D3 P0_3
 * #define D4 P0_4
 * #define D5 P0_5
 * #define D6 P0_6
 * #define D7 P0_7
 * #define D8 P1_4
 * #define D9 P1_5
 * #define D10 P1_3
 * #define D11 P1_1
 * #define D12 P1_2
 * #define D13 P1_0
 * #endif
 *
 * // example code declare SPI interface
 * #if defined(TARGET_MAX32625MBED)
 * 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
 * DigitalOut spi_cs(SPI1_SS); // TARGET_MAX32625MBED: P1_3 Arduino 10-pin header D10
 * #elif defined(TARGET_MAX32600MBED)
 * SPI spi(SPI2_MOSI, SPI2_MISO, SPI2_SCK); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13
 * DigitalOut spi_cs(SPI2_SS); // Generic: Arduino 10-pin header D10
 * #else
 * SPI spi(D11, D12, D13); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13
 * DigitalOut spi_cs(D10); // Generic: Arduino 10-pin header D10
 * #endif
 *
 * // example code declare GPIO interface pins
 * // AnalogOut FB_pin(Px_x_PortName_To_Be_Determined); // Analog Input to MAX5171 device
 * DigitalOut RS_pin(D9); // Digital Configuration Input to MAX5171 device
 * DigitalOut PDLb_pin(D8); // Digital Configuration Input to MAX5171 device
 * DigitalOut CLRb_pin(D7); // Digital Configuration Input to MAX5171 device
 * DigitalOut SHDN_pin(D6); // Digital Configuration Input to MAX5171 device
 * // AnalogIn OUT_pin(A0); // Analog Output from MAX5171 device
 * DigitalIn UPO_pin(D5); // Digital General-Purpose Output from MAX5171 device
 * // example code declare device instance
 * MAX5171 g_MAX5171_device(spi, spi_cs, RS_pin, PDLb_pin, CLRb_pin, SHDN_pin, UPO_pin, MAX5171::MAX5171_IC);
 *
 * // example code main function
 * int main()
 * {
 *     g_MAX5171_device.Init();
 *
 *     while (1)
 *     {
 *         uint16_t code;
 *         //
 *         // example #1
 *         code = 0x3332; // 80.0% of full scale REF(2.50V) = 2.00V
 *         g_MAX5171_device.CODE_LOAD(code);
 *         //
 *         // example #2
 *         code = 0x1fff; // 50.0% of full scale REF(2.50V) = 1.25V
 *         g_MAX5171_device.CODE_LOAD(code);
 *         //
 *         // example #3
 *         code = 0x1999; // 40.0% of full scale REF(2.50V) = 1.00V
 *         g_MAX5171_device.CODE_LOAD(code);
 *         //
 *         // example #4
 *         code = 0x3fff; // 100.0% of full scale REF(2.50V) = 2.50V
 *         g_MAX5171_device.CODE_LOAD(code);
 *
 *         // wait(3.0);
 *     }
 * }
 * @endcode
 */
class MAX5171 {
public:
    //----------------------------------------
    /// Command Codes (first byte)
    ///
    /// Naming convention is CMD_bitstream_FUNCTION_NAME
    /// - dd_dddd_dddd_dddd = data field
    /// - xxxx = don't care
    typedef enum MAX5171_CMD_enum_t {
        CMD_00dd_dddd_dddd_dddd_CODE = 0x0000, //!< 16'b0000000000000000
        CMD_01dd_dddd_dddd_dddd_CODE_LOAD = 0x4000, //!< 16'b0100000000000000
        CMD_10xx_xxxx_xxxx_xxxx_LOAD = 0x8000, //!< 16'b1000000000000000
        CMD_1100_xxxx_xxxx_xxxx_NOP = 0xc000, //!< 16'b1100000000000000
        CMD_1101_xxxx_xxxx_xxxx_SHUTDOWN = 0xd000, //!< 16'b1101000000000000
        CMD_1110_0xxx_xxxx_xxxx_UPO_LOW = 0xe000, //!< 16'b1110000000000000
        CMD_1110_1xxx_xxxx_xxxx_UPO_HIGH = 0xe800, //!< 16'b1110100000000000
        CMD_1111_0xxx_xxxx_xxxx_MODE1_DOUT_SCLK_RISING_EDGE = 0xf000, //!< 16'b1111000000000000
        CMD_1111_1xxx_xxxx_xxxx_MODE0_DOUT_SCLK_FALLING_EDGE = 0xf800, //!< 16'b1111100000000000
    } MAX5171_CMD_enum_t;

    /**
     * @brief IC's supported with this driver
     * @details MAX5171
     */
    typedef enum
    {
        MAX5171_IC = 0,
        //MAX5171_IC = 1
    } MAX5171_ic_t;

    /**********************************************************//**
    * @brief Constructor for MAX5171 Class.
    *
    * @details Requires an existing SPI object as well as a DigitalOut object.
    * The DigitalOut object is used for a chip enable signal
    *
    * On Entry:
    *     @param[in] spi - pointer to existing SPI object
    *     @param[in] cs_pin - pointer to a DigitalOut pin object
    *     @param[in] RS_pin - pointer to a DigitalOut pin object
    *     @param[in] PDLb_pin - pointer to a DigitalOut pin object
    *     @param[in] CLRb_pin - pointer to a DigitalOut pin object
    *     @param[in] SHDN_pin - pointer to a DigitalOut pin object
    *     @param[in] UPO_pin - pointer to a DigitalIn pin object
    *     @param[in] ic_variant - which type of MAX5171 is used
    *
    * On Exit:
    *
    * @return None
    **************************************************************/
    MAX5171(SPI &spi, DigitalOut &cs_pin, // SPI interface
            // AnalogOut &FB_pin, // Analog Input to MAX5171 device
            DigitalOut &RS_pin, // Digital Configuration Input to MAX5171 device
            DigitalOut &PDLb_pin, // Digital Configuration Input to MAX5171 device
            DigitalOut &CLRb_pin, // Digital Configuration Input to MAX5171 device
            DigitalOut &SHDN_pin, // Digital Configuration Input to MAX5171 device
            // AnalogIn &OUT_pin, // Analog Output from MAX5171 device
            DigitalIn &UPO_pin, // Digital General-Purpose Output from MAX5171 device
            MAX5171_ic_t ic_variant);

    /************************************************************
     * @brief Default destructor for MAX5171 Class.
     *
     * @details Destroys SPI object if owner
     *
     * On Entry:
     *
     * On Exit:
     *
     * @return None
     **************************************************************/
    ~MAX5171();

    /// Function pointer void f(size_t byteCount, uint8_t mosiData[], uint8_t misoData[])
    Callback<void(size_t, uint8_t*, uint8_t*)> onSPIprint; //!< optional @ref onSPIprint SPI diagnostic function

    /// set SPI SCLK frequency
    void spi_frequency(int spi_sclk_Hz);

    /// get SPI SCLK frequency
    int get_spi_frequency() const { return m_SPI_SCLK_Hz; }

    /// get SPI mode
    int get_spi_dataMode() const { return m_SPI_dataMode; }

//----------------------------------------
public:

    /// reference voltage, in Volts
    double VRef;

    /// shadow of dacCodeLsbs; write-only dacCodeLsbs field CMD_00dd_dddd_dddd_dddd_CODE or CMD_01dd_dddd_dddd_dddd_CODE_LOAD
    int16_t DACCode;


//----------------------------------------
// Assert SPI Chip Select
// SPI chip-select for MAX5171
//
    void SPIoutputCS(int isLogicHigh);

//----------------------------------------
// SPI write 16 bits
// SPI interface to MAX5171 shift 16 bits mosiData into MAX5171 DIN
//
    void SPIwrite16bits(int16_t mosiData16);

private:
    // SPI object
    SPI &m_spi;
    int m_SPI_SCLK_Hz;
    int m_SPI_dataMode;
    int m_SPI_cs_state;

    // Selector pin object
    DigitalOut &m_cs_pin;

// InputPin Name = FB
// InputPin Description = Feedback Input
// InputPin Function = Analog
//
// InputPin Name = RS
// InputPin Description = Reset Mode Select (digital input). Connect to VDD to select midscale reset output value. Connect to DGND
// to select 0 reset output value.
// InputPin Function = Configuration
    DigitalOut &m_RS_pin;
//
// InputPin Name = PDL#
// InputPin Description = Power-Down Lockout (digital input). Connect to VDD to allow shutdown. Connect to DGND to disable shutdown.
// InputPin Function = Configuration
    DigitalOut &m_PDLb_pin;
//
// InputPin Name = CLR#
// InputPin Description = Clear DAC (digital input). Clears the DAC to its predetermined output state as set by RS.
// InputPin Function = Configuration
    DigitalOut &m_CLRb_pin;
//
// InputPin Name = SHDN
// InputPin Description = Shutdown (digital input). Pulling SHDN high when PDL = VDD places the chip in shutdown mode with a
// maximum shutdown current 0f 10uA.
// InputPin Function = Configuration
    DigitalOut &m_SHDN_pin;
//
// OutputPin Name = OUT
// OutputPin Description = Analog Voltage Output. High impedance in shutdown. Output voltage is limited to VDD.
// OutputPin Function = Analog
    // AnalogIn &m_OUT_pin;
//
// OutputPin Name = UPO
// OutputPin Description = User-Programmable Output. State is set by serial input.
// OutputPin Function = General-Purpose
    DigitalIn &m_UPO_pin;
//

    // Identifies which IC variant is being used
    MAX5171_ic_t m_ic_variant;

public:

    //----------------------------------------
    /// Menu item '!'
    /// Initialize device
    /// @return 1 on success; 0 on failure
    uint8_t Init(void);

    //----------------------------------------
    /// Return the DAC register value corresponding to physical voltage.
    /// Does not perform any offset or gain correction.
    ///
    /// @pre g_MAX5171_device.VRef = Voltage of REF input, in Volts
    /// @param[in] voltage = physical voltage in Volts
    /// @return raw 14-bit MAX5171 code (right justified).
    uint16_t DACCodeOfVoltage(double voltageV);

    //----------------------------------------
    /// Return the physical voltage corresponding to DAC register.
    /// Does not perform any offset or gain correction.
    ///
    /// @pre g_MAX5171_device.VRef = Voltage of REF input, in Volts
    /// @param[in] value_u14: raw 14-bit MAX5171 code (right justified).
    /// @return physical voltage corresponding to MAX5171 code.
    double VoltageOfCode(uint16_t value_u14);

    //----------------------------------------
    /// CMD_00dd_dddd_dddd_dddd_CODE
    ///
    /// Load input register; DAC registers are unchanged.
    /// @return 1 on success; 0 on failure
    uint8_t CODE(uint16_t dacCodeLsbs);

    //----------------------------------------
    /// CMD_01dd_dddd_dddd_dddd_CODE_LOAD
    ///
    /// Load input register; DAC registers are updated (start up DAC with new data).
    /// @return 1 on success; 0 on failure
    uint8_t CODE_LOAD(uint16_t dacCodeLsbs);

    //----------------------------------------
    /// CMD_10xx_xxxx_xxxx_xxxx_LOAD
    ///
    /// Update DAC register from input register (start up DAC with data previously
    /// stored in the input registers).
    /// @return 1 on success; 0 on failure
    uint8_t LOAD(void);

    //----------------------------------------
    /// CMD_1100_xxxx_xxxx_xxxx_NOP
    ///
    /// No operation (NOP).
    /// @return 1 on success; 0 on failure
    uint8_t NOP(void);

    //----------------------------------------
    /// CMD_1101_xxxx_xxxx_xxxx_SHUTDOWN
    ///
    /// Shut down DAC (provided PDL# = 1).
    /// @return 1 on success; 0 on failure
    uint8_t SHUTDOWN(void);

    //----------------------------------------
    /// CMD_1110_0xxx_xxxx_xxxx_UPO_LOW
    ///
    /// UPO goes low (default).
    /// @return 1 on success; 0 on failure
    uint8_t UPO_LOW(void);

    //----------------------------------------
    /// CMD_1110_1xxx_xxxx_xxxx_UPO_HIGH
    ///
    /// UPO goes high.
    /// @return 1 on success; 0 on failure
    uint8_t UPO_HIGH(void);

    //----------------------------------------
    /// CMD_1111_0xxx_xxxx_xxxx_MODE1_DOUT_SCLK_RISING_EDGE
    ///
    /// Mode 1, DOUT clocked out on SCLK's rising edge.
    /// @return 1 on success; 0 on failure
    uint8_t MODE1_DOUT_SCLK_RISING_EDGE(void);

    //----------------------------------------
    /// CMD_1111_1xxx_xxxx_xxxx_MODE0_DOUT_SCLK_FALLING_EDGE
    ///
    /// Mode 0, DOUT clocked out on SCLK's falling edge (default).
    /// @return 1 on success; 0 on failure
    uint8_t MODE0_DOUT_SCLK_FALLING_EDGE(void);

}; // end of class MAX5171

#endif // __MAX5171_H__

// End of file