Board library for MAX32620FTHR platform
Dependents: MAX32620FTHR_Pmic MAX32620FTHR_Pmic_Boot MAX32620FTHR_GPS_Tracker firmware_framework1
Fork of MAX32620FTHR by
The MAX32620FTHR platform library provides board level functions for the MAX32620FTHR platform. The MAX32620 ARM Cortex-M4F microcontroller provides two I/O supply rails, VDDIO and VDDIOH. The MAX32620FTHR platform supplies VDDIO at 1.8V and VDDIOH at 3.3V. After reset all GPIO pins will use VDDIO.
MAX32620FTHR.h@0:7fb8d4388fe1, 2018-04-19 (annotated)
- Committer:
- jessexm
- Date:
- Thu Apr 19 00:26:37 2018 +0000
- Revision:
- 0:7fb8d4388fe1
Initial commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
jessexm | 0:7fb8d4388fe1 | 1 | /******************************************************************************* |
jessexm | 0:7fb8d4388fe1 | 2 | * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved. |
jessexm | 0:7fb8d4388fe1 | 3 | * |
jessexm | 0:7fb8d4388fe1 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a |
jessexm | 0:7fb8d4388fe1 | 5 | * copy of this software and associated documentation files (the "Software"), |
jessexm | 0:7fb8d4388fe1 | 6 | * to deal in the Software without restriction, including without limitation |
jessexm | 0:7fb8d4388fe1 | 7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
jessexm | 0:7fb8d4388fe1 | 8 | * and/or sell copies of the Software, and to permit persons to whom the |
jessexm | 0:7fb8d4388fe1 | 9 | * Software is furnished to do so, subject to the following conditions: |
jessexm | 0:7fb8d4388fe1 | 10 | * |
jessexm | 0:7fb8d4388fe1 | 11 | * The above copyright notice and this permission notice shall be included |
jessexm | 0:7fb8d4388fe1 | 12 | * in all copies or substantial portions of the Software. |
jessexm | 0:7fb8d4388fe1 | 13 | * |
jessexm | 0:7fb8d4388fe1 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
jessexm | 0:7fb8d4388fe1 | 15 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
jessexm | 0:7fb8d4388fe1 | 16 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
jessexm | 0:7fb8d4388fe1 | 17 | * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
jessexm | 0:7fb8d4388fe1 | 18 | * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
jessexm | 0:7fb8d4388fe1 | 19 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
jessexm | 0:7fb8d4388fe1 | 20 | * OTHER DEALINGS IN THE SOFTWARE. |
jessexm | 0:7fb8d4388fe1 | 21 | * |
jessexm | 0:7fb8d4388fe1 | 22 | * Except as contained in this notice, the name of Maxim Integrated |
jessexm | 0:7fb8d4388fe1 | 23 | * Products, Inc. shall not be used except as stated in the Maxim Integrated |
jessexm | 0:7fb8d4388fe1 | 24 | * Products, Inc. Branding Policy. |
jessexm | 0:7fb8d4388fe1 | 25 | * |
jessexm | 0:7fb8d4388fe1 | 26 | * The mere transfer of this software does not imply any licenses |
jessexm | 0:7fb8d4388fe1 | 27 | * of trade secrets, proprietary technology, copyrights, patents, |
jessexm | 0:7fb8d4388fe1 | 28 | * trademarks, maskwork rights, or any other form of intellectual |
jessexm | 0:7fb8d4388fe1 | 29 | * property whatsoever. Maxim Integrated Products, Inc. retains all |
jessexm | 0:7fb8d4388fe1 | 30 | * ownership rights. |
jessexm | 0:7fb8d4388fe1 | 31 | ******************************************************************************* |
jessexm | 0:7fb8d4388fe1 | 32 | */ |
jessexm | 0:7fb8d4388fe1 | 33 | |
jessexm | 0:7fb8d4388fe1 | 34 | #ifndef _MAX32620FTHR_H_ |
jessexm | 0:7fb8d4388fe1 | 35 | #define _MAX32620FTHR_H_ |
jessexm | 0:7fb8d4388fe1 | 36 | |
jessexm | 0:7fb8d4388fe1 | 37 | #include "mbed.h" |
jessexm | 0:7fb8d4388fe1 | 38 | |
jessexm | 0:7fb8d4388fe1 | 39 | /** |
jessexm | 0:7fb8d4388fe1 | 40 | * @brief MAX32620FTHR Board Support Library |
jessexm | 0:7fb8d4388fe1 | 41 | * |
jessexm | 0:7fb8d4388fe1 | 42 | * @details The MAX32620FTHR is a rapid development application board for |
jessexm | 0:7fb8d4388fe1 | 43 | * ultra low power wearable applications. It includes common peripherals and |
jessexm | 0:7fb8d4388fe1 | 44 | * expansion connectors all power optimized for getting the longest life from |
jessexm | 0:7fb8d4388fe1 | 45 | * the battery. This library configures the power and I/O for the board. |
jessexm | 0:7fb8d4388fe1 | 46 | * <br>https://www.maximintegrated.com/max32620fthr |
jessexm | 0:7fb8d4388fe1 | 47 | * |
jessexm | 0:7fb8d4388fe1 | 48 | * @code |
jessexm | 0:7fb8d4388fe1 | 49 | * #include "mbed.h" |
jessexm | 0:7fb8d4388fe1 | 50 | * #include "MAX32620FTHR.h" |
jessexm | 0:7fb8d4388fe1 | 51 | * |
jessexm | 0:7fb8d4388fe1 | 52 | * DigitalOut led1(LED1); |
jessexm | 0:7fb8d4388fe1 | 53 | * |
jessexm | 0:7fb8d4388fe1 | 54 | * // Initialize I/O voltages on MAX32620FTHR board |
jessexm | 0:7fb8d4388fe1 | 55 | * MAX32620FTHR fthr(MAX32620FTHR::VIO_3V3); |
jessexm | 0:7fb8d4388fe1 | 56 | * |
jessexm | 0:7fb8d4388fe1 | 57 | * // main() runs in its own thread in the OS |
jessexm | 0:7fb8d4388fe1 | 58 | * // (note the calls to Thread::wait below for delays) |
jessexm | 0:7fb8d4388fe1 | 59 | * int main() |
jessexm | 0:7fb8d4388fe1 | 60 | * { |
jessexm | 0:7fb8d4388fe1 | 61 | * while (true) { |
jessexm | 0:7fb8d4388fe1 | 62 | * led1 = !led1; |
jessexm | 0:7fb8d4388fe1 | 63 | * Thread::wait(500); |
jessexm | 0:7fb8d4388fe1 | 64 | * } |
jessexm | 0:7fb8d4388fe1 | 65 | * } |
jessexm | 0:7fb8d4388fe1 | 66 | * @endcode |
jessexm | 0:7fb8d4388fe1 | 67 | */ |
jessexm | 0:7fb8d4388fe1 | 68 | class MAX32620FTHR |
jessexm | 0:7fb8d4388fe1 | 69 | { |
jessexm | 0:7fb8d4388fe1 | 70 | public: |
jessexm | 0:7fb8d4388fe1 | 71 | // max32620fthr configuration utilities |
jessexm | 0:7fb8d4388fe1 | 72 | |
jessexm | 0:7fb8d4388fe1 | 73 | /** |
jessexm | 0:7fb8d4388fe1 | 74 | * @brief IO Voltage |
jessexm | 0:7fb8d4388fe1 | 75 | * @details Enumerated options for operating voltage |
jessexm | 0:7fb8d4388fe1 | 76 | */ |
jessexm | 0:7fb8d4388fe1 | 77 | typedef enum { |
jessexm | 0:7fb8d4388fe1 | 78 | VIO_1V8 = 0x00, ///< 1.8V IO voltage at headers (from BUCK0) |
jessexm | 0:7fb8d4388fe1 | 79 | VIO_3V3 = 0x01, ///< 3.3V IO voltage at headers (from BUCK2) |
jessexm | 0:7fb8d4388fe1 | 80 | } vio_t; |
jessexm | 0:7fb8d4388fe1 | 81 | |
jessexm | 0:7fb8d4388fe1 | 82 | /** |
jessexm | 0:7fb8d4388fe1 | 83 | * MAX32620FTHR constructor. |
jessexm | 0:7fb8d4388fe1 | 84 | */ |
jessexm | 0:7fb8d4388fe1 | 85 | MAX32620FTHR(); |
jessexm | 0:7fb8d4388fe1 | 86 | |
jessexm | 0:7fb8d4388fe1 | 87 | /** |
jessexm | 0:7fb8d4388fe1 | 88 | * MAX32620FTHR constructor. |
jessexm | 0:7fb8d4388fe1 | 89 | */ |
jessexm | 0:7fb8d4388fe1 | 90 | MAX32620FTHR(vio_t vio); |
jessexm | 0:7fb8d4388fe1 | 91 | |
jessexm | 0:7fb8d4388fe1 | 92 | /** |
jessexm | 0:7fb8d4388fe1 | 93 | * MAX32620FTHR destructor. |
jessexm | 0:7fb8d4388fe1 | 94 | */ |
jessexm | 0:7fb8d4388fe1 | 95 | ~MAX32620FTHR(); |
jessexm | 0:7fb8d4388fe1 | 96 | |
jessexm | 0:7fb8d4388fe1 | 97 | /** |
jessexm | 0:7fb8d4388fe1 | 98 | * @brief Initialize MAX32620FTHR board |
jessexm | 0:7fb8d4388fe1 | 99 | * @details Initializes I/O voltage on MAX32620FTHR board. |
jessexm | 0:7fb8d4388fe1 | 100 | * Sets I/O voltage for LEDs to 3.3V and header pins to hdrVio specified. |
jessexm | 0:7fb8d4388fe1 | 101 | * @param hdrVio I/O voltage for header pins |
jessexm | 0:7fb8d4388fe1 | 102 | * @returns 0 if no errors, -1 if error. |
jessexm | 0:7fb8d4388fe1 | 103 | */ |
jessexm | 0:7fb8d4388fe1 | 104 | int init(vio_t hdrVio); |
jessexm | 0:7fb8d4388fe1 | 105 | |
jessexm | 0:7fb8d4388fe1 | 106 | /** |
jessexm | 0:7fb8d4388fe1 | 107 | * @brief Sets I/O Voltage |
jessexm | 0:7fb8d4388fe1 | 108 | * @details Sets the voltage rail to be used for a given pin. |
jessexm | 0:7fb8d4388fe1 | 109 | * VIO_1V8 selects VDDIO which is supplied by Buck0, which is set at 1.8V, |
jessexm | 0:7fb8d4388fe1 | 110 | * VIO_3V3 selects VDDIOH which is supplied by Buck2, which is typically 3.3V |
jessexm | 0:7fb8d4388fe1 | 111 | * @param pin Pin whose voltage supply is being assigned. |
jessexm | 0:7fb8d4388fe1 | 112 | * @param vio Voltage rail to be used for specified pin. |
jessexm | 0:7fb8d4388fe1 | 113 | * @returns 0 if no errors, -1 if error. |
jessexm | 0:7fb8d4388fe1 | 114 | */ |
jessexm | 0:7fb8d4388fe1 | 115 | int vddioh(PinName pin, vio_t vio); |
jessexm | 0:7fb8d4388fe1 | 116 | }; |
jessexm | 0:7fb8d4388fe1 | 117 | |
jessexm | 0:7fb8d4388fe1 | 118 | #endif /* _MAX32620FTHR_H_ */ |