Maxim Integrated / Mbed OS MAX5715BOB_12bit_4ch_SPI_DAC

Example host software for the Maxim Integrated MAX5715 12-bit 4-channel voltage-output DAC. Hosted on the MAX32625MBED.

Dependencies:   MAX5715

main.cpp@5:e9594321c488, 2019-05-16 (annotated)

Committer:
whismanoid
Date:
Thu May 16 19:05:16 2019 +0000
Revision:
5:e9594321c488
Parent:
4:00b24a55a098
Child:
6:0bfe0d990850
improve documentation; Serial USBTX,USBRX

Who changed what in which revision?

UserRevisionLine numberNew contents of line
whismanoid 2:015f0dc1ff16 1 // /*******************************************************************************
whismanoid 2:015f0dc1ff16 2 // * Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved.
whismanoid 2:015f0dc1ff16 3 // *
whismanoid 2:015f0dc1ff16 4 // * Permission is hereby granted, free of charge, to any person obtaining a
whismanoid 2:015f0dc1ff16 5 // * copy of this software and associated documentation files (the "Software"),
whismanoid 2:015f0dc1ff16 6 // * to deal in the Software without restriction, including without limitation
whismanoid 2:015f0dc1ff16 7 // * the rights to use, copy, modify, merge, publish, distribute, sublicense,
whismanoid 2:015f0dc1ff16 8 // * and/or sell copies of the Software, and to permit persons to whom the
whismanoid 2:015f0dc1ff16 9 // * Software is furnished to do so, subject to the following conditions:
whismanoid 2:015f0dc1ff16 10 // *
whismanoid 2:015f0dc1ff16 11 // * The above copyright notice and this permission notice shall be included
whismanoid 2:015f0dc1ff16 12 // * in all copies or substantial portions of the Software.
whismanoid 2:015f0dc1ff16 13 // *
whismanoid 2:015f0dc1ff16 14 // * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
whismanoid 2:015f0dc1ff16 15 // * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
whismanoid 2:015f0dc1ff16 16 // * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
whismanoid 2:015f0dc1ff16 17 // * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
whismanoid 2:015f0dc1ff16 18 // * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
whismanoid 2:015f0dc1ff16 19 // * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
whismanoid 2:015f0dc1ff16 20 // * OTHER DEALINGS IN THE SOFTWARE.
whismanoid 2:015f0dc1ff16 21 // *
whismanoid 2:015f0dc1ff16 22 // * Except as contained in this notice, the name of Maxim Integrated
whismanoid 2:015f0dc1ff16 23 // * Products, Inc. shall not be used except as stated in the Maxim Integrated
whismanoid 2:015f0dc1ff16 24 // * Products, Inc. Branding Policy.
whismanoid 2:015f0dc1ff16 25 // *
whismanoid 2:015f0dc1ff16 26 // * The mere transfer of this software does not imply any licenses
whismanoid 2:015f0dc1ff16 27 // * of trade secrets, proprietary technology, copyrights, patents,
whismanoid 2:015f0dc1ff16 28 // * trademarks, maskwork rights, or any other form of intellectual
whismanoid 2:015f0dc1ff16 29 // * property whatsoever. Maxim Integrated Products, Inc. retains all
whismanoid 2:015f0dc1ff16 30 // * ownership rights.
whismanoid 2:015f0dc1ff16 31 // *******************************************************************************
whismanoid 2:015f0dc1ff16 32 // */
whismanoid 3:9db1ff35500e 33 //---------- CODE GENERATOR: testMainCppCodeList
whismanoid 3:9db1ff35500e 34 // CODE GENERATOR: example code includes
whismanoid 2:015f0dc1ff16 35 // example code includes
whismanoid 0:cb3754747a08 36 #include "mbed.h"
whismanoid 0:cb3754747a08 37 //#include "max32625.h"
whismanoid 0:cb3754747a08 38 #include "MAX5715.h"
whismanoid 5:e9594321c488 39
whismanoid 5:e9594321c488 40 // optional: serial port
whismanoid 5:e9594321c488 41 //#include "USBSerial.h"
whismanoid 5:e9594321c488 42 Serial serial(USBTX, USBRX); // tx, rx
whismanoid 0:cb3754747a08 43
whismanoid 2:015f0dc1ff16 44 // example code board support
whismanoid 0:cb3754747a08 45 //MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);
whismanoid 0:cb3754747a08 46 //DigitalOut rLED(LED1);
whismanoid 0:cb3754747a08 47 //DigitalOut gLED(LED2);
whismanoid 0:cb3754747a08 48 //DigitalOut bLED(LED3);
whismanoid 2:015f0dc1ff16 49 //
whismanoid 5:e9594321c488 50 // Arduino "shield" connector port definitions (MAX32625MBED shown)
whismanoid 5:e9594321c488 51 #if defined(TARGET_MAX32625MBED)
whismanoid 5:e9594321c488 52 #define A0 AIN_0
whismanoid 5:e9594321c488 53 #define A1 AIN_1
whismanoid 5:e9594321c488 54 #define A2 AIN_2
whismanoid 5:e9594321c488 55 #define A3 AIN_3
whismanoid 5:e9594321c488 56 #define D0 P0_0
whismanoid 5:e9594321c488 57 #define D1 P0_1
whismanoid 5:e9594321c488 58 #define D2 P0_2
whismanoid 5:e9594321c488 59 #define D3 P0_3
whismanoid 5:e9594321c488 60 #define D4 P0_4
whismanoid 5:e9594321c488 61 #define D5 P0_5
whismanoid 5:e9594321c488 62 #define D6 P0_6
whismanoid 5:e9594321c488 63 #define D7 P0_7
whismanoid 2:015f0dc1ff16 64 #define D8 P1_4
whismanoid 2:015f0dc1ff16 65 #define D9 P1_5
whismanoid 5:e9594321c488 66 #define D10 P1_3
whismanoid 5:e9594321c488 67 #define D11 P1_1
whismanoid 5:e9594321c488 68 #define D12 P1_2
whismanoid 5:e9594321c488 69 #define D13 P1_0
whismanoid 5:e9594321c488 70 #endif
whismanoid 2:015f0dc1ff16 71
whismanoid 2:015f0dc1ff16 72 // example code declare SPI interface
whismanoid 4:00b24a55a098 73 #if defined(TARGET_MAX32625MBED)
whismanoid 4:00b24a55a098 74 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 4:00b24a55a098 75 DigitalOut spi_cs(SPI1_SS); // TARGET_MAX32625MBED: P1_3 Arduino 10-pin header D10
whismanoid 4:00b24a55a098 76 #elif defined(TARGET_MAX32600MBED)
whismanoid 4:00b24a55a098 77 SPI spi(SPI2_MOSI, SPI2_MISO, SPI2_SCK); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13
whismanoid 4:00b24a55a098 78 DigitalOut spi_cs(SPI2_SS); // Generic: Arduino 10-pin header D10
whismanoid 4:00b24a55a098 79 #else
whismanoid 4:00b24a55a098 80 SPI spi(D11, D12, D13); // mosi, miso, sclk spi1 TARGET_MAX32600MBED: Arduino 10-pin header D11 D12 D13
whismanoid 4:00b24a55a098 81 DigitalOut spi_cs(D10); // Generic: Arduino 10-pin header D10
whismanoid 4:00b24a55a098 82 #endif
whismanoid 2:015f0dc1ff16 83
whismanoid 2:015f0dc1ff16 84 // example code declare GPIO interface pins
whismanoid 2:015f0dc1ff16 85 DigitalOut LDACb_pin(D9); // Digital Trigger Input to device
whismanoid 2:015f0dc1ff16 86 DigitalOut CLRb_pin(D8); // Digital Trigger Input to device
whismanoid 3:9db1ff35500e 87 // AnalogOut REF_pin(Px_x_PortName_To_Be_Determined); // Reference Input to device
whismanoid 3:9db1ff35500e 88 // AnalogIn OUTA_pin(A0); // Analog Output from device
whismanoid 3:9db1ff35500e 89 // AnalogIn OUTB_pin(A1); // Analog Output from device
whismanoid 3:9db1ff35500e 90 // AnalogIn OUTC_pin(A2); // Analog Output from device
whismanoid 3:9db1ff35500e 91 // AnalogIn OUTD_pin(A3); // Analog Output from device
whismanoid 3:9db1ff35500e 92 // DigitalIn RDYb_pin(Px_x_PortName_To_Be_Determined); // Digital DaisyChain Output from device
whismanoid 2:015f0dc1ff16 93 // example code declare device instance
whismanoid 1:f82c4c7fe134 94 MAX5715 g_MAX5715_device(spi, spi_cs, LDACb_pin, CLRb_pin, MAX5715::MAX5715_IC);
whismanoid 0:cb3754747a08 95
whismanoid 2:015f0dc1ff16 96 // example code main function
whismanoid 0:cb3754747a08 97 int main()
whismanoid 0:cb3754747a08 98 {
whismanoid 5:e9594321c488 99 // example code: serial port banner message
whismanoid 5:e9594321c488 100 #if defined(TARGET_MAX32625MBED)
whismanoid 5:e9594321c488 101 serial.printf("MAX32625MBED ");
whismanoid 5:e9594321c488 102 #elif defined(TARGET_MAX32600MBED)
whismanoid 5:e9594321c488 103 serial.printf("MAX32600MBED ");
whismanoid 5:e9594321c488 104 #elif defined(TARGET_NUCLEO_F446RE)
whismanoid 5:e9594321c488 105 serial.printf("NUCLEO_F446RE ");
whismanoid 5:e9594321c488 106 #endif
whismanoid 5:e9594321c488 107 serial.printf("MAX5715BOB\r\n");
whismanoid 5:e9594321c488 108
whismanoid 3:9db1ff35500e 109 //MAX5715 dac(spi, spi_cs, MAX5715::MAX5715_IC);
whismanoid 3:9db1ff35500e 110 //dac.Init();
whismanoid 3:9db1ff35500e 111
whismanoid 3:9db1ff35500e 112 // CODE GENERATOR: example code: member function Init
whismanoid 2:015f0dc1ff16 113 g_MAX5715_device.Init();
whismanoid 0:cb3754747a08 114
whismanoid 3:9db1ff35500e 115 // CODE GENERATOR: example code: member function REF
whismanoid 3:9db1ff35500e 116 // CODE GENERATOR: example code: device has enumType 'MAX5715_REF_enum_t'
whismanoid 3:9db1ff35500e 117 // 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:cb3754747a08 118 g_MAX5715_device.REF(MAX5715::REF_AlwaysOn_2V500);
whismanoid 0:cb3754747a08 119
whismanoid 3:9db1ff35500e 120 // CODE GENERATOR: example code: has no member function CODE_LOAD
whismanoid 3:9db1ff35500e 121 // CODE GENERATOR: example code: member function CODEallLOADall
whismanoid 0:cb3754747a08 122 //uint16_t code = 4095;
whismanoid 0:cb3754747a08 123 //g_MAX5715_device.CODEallLOADall(code);
whismanoid 0:cb3754747a08 124
whismanoid 3:9db1ff35500e 125 // CODE GENERATOR: example code: member function CODEnLOADn
whismanoid 0:cb3754747a08 126 //
whismanoid 0:cb3754747a08 127 uint16_t ch = 0;
whismanoid 0:cb3754747a08 128 uint16_t code = 0xccc;
whismanoid 0:cb3754747a08 129 g_MAX5715_device.CODEnLOADn(ch, code);
whismanoid 0:cb3754747a08 130 //
whismanoid 0:cb3754747a08 131 ch = 1;
whismanoid 0:cb3754747a08 132 code = 0x800;
whismanoid 0:cb3754747a08 133 g_MAX5715_device.CODEnLOADn(ch, code);
whismanoid 0:cb3754747a08 134 //
whismanoid 0:cb3754747a08 135 ch = 2;
whismanoid 0:cb3754747a08 136 code = 0x666;
whismanoid 0:cb3754747a08 137 g_MAX5715_device.CODEnLOADn(ch, code);
whismanoid 0:cb3754747a08 138 //
whismanoid 0:cb3754747a08 139 ch = 3;
whismanoid 0:cb3754747a08 140 code = 0xFFF;
whismanoid 0:cb3754747a08 141 g_MAX5715_device.CODEnLOADn(ch, code);
whismanoid 0:cb3754747a08 142
whismanoid 3:9db1ff35500e 143 // CODE GENERATOR: example code: has no member function ScanManual
whismanoid 3:9db1ff35500e 144 // CODE GENERATOR: example code: has no member function ReadAINcode
whismanoid 0:cb3754747a08 145 //wait(1.0);
whismanoid 0:cb3754747a08 146 }
whismanoid 3:9db1ff35500e 147 //---------- CODE GENERATOR: end testMainCppCodeList