Diff: MAX32620FTHR.h

Revision:

0:7fb8d4388fe1

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MAX32620FTHR.h	Thu Apr 19 00:26:37 2018 +0000
@@ -0,0 +1,118 @@
+/*******************************************************************************
+ * Copyright (C) 2018 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.
+ *******************************************************************************
+ */
+
+#ifndef _MAX32620FTHR_H_
+#define _MAX32620FTHR_H_
+
+#include "mbed.h"
+
+/**
+ * @brief MAX32620FTHR Board Support Library
+ *
+ * @details The MAX32620FTHR is a rapid development application board for
+ * ultra low power wearable applications.  It includes common peripherals and
+ * expansion connectors all power optimized for getting the longest life from
+ * the battery.  This library configures the power and I/O for the board.
+ * <br>https://www.maximintegrated.com/max32620fthr
+ *
+ * @code
+ * #include "mbed.h"
+ * #include "MAX32620FTHR.h"
+ *
+ * DigitalOut led1(LED1);
+ *
+ * // Initialize I/O voltages on MAX32620FTHR board
+ * MAX32620FTHR fthr(MAX32620FTHR::VIO_3V3);
+ *
+ * // main() runs in its own thread in the OS
+ * // (note the calls to Thread::wait below for delays)
+ * int main()
+ * {
+ *     while (true) {
+ *         led1 = !led1;
+ *         Thread::wait(500);
+ *     }
+ * }
+ * @endcode
+ */
+class MAX32620FTHR
+{
+public:
+    // max32620fthr configuration utilities
+
+    /**
+      * @brief   IO Voltage
+      * @details Enumerated options for operating voltage
+      */
+    typedef enum {
+        VIO_1V8 = 0x00,    ///< 1.8V IO voltage at headers (from BUCK0)
+        VIO_3V3 = 0x01,    ///< 3.3V IO voltage at headers (from BUCK2)
+    } vio_t;
+
+    /**
+     * MAX32620FTHR constructor.
+     */
+    MAX32620FTHR();
+
+    /**
+     * MAX32620FTHR constructor.
+     */
+    MAX32620FTHR(vio_t vio);
+
+    /**
+     * MAX32620FTHR destructor.
+     */
+    ~MAX32620FTHR();
+
+    /**
+     * @brief   Initialize MAX32620FTHR board
+     * @details Initializes I/O voltage on MAX32620FTHR board.
+     *  Sets I/O voltage for LEDs to 3.3V and header pins to hdrVio specified.
+     * @param hdrVio I/O voltage for header pins
+     * @returns 0 if no errors, -1 if error.
+    */
+    int init(vio_t hdrVio);
+
+    /**
+     * @brief   Sets I/O Voltage
+     * @details Sets the voltage rail to be used for a given pin.
+     *  VIO_1V8 selects VDDIO which is supplied by Buck0, which is set at 1.8V,
+     *  VIO_3V3 selects VDDIOH which is supplied by Buck2, which is typically 3.3V
+     * @param   pin Pin whose voltage supply is being assigned.
+     * @param   vio Voltage rail to be used for specified pin.
+     * @returns 0 if no errors, -1 if error.
+    */
+    int vddioh(PinName pin, vio_t vio);
+};
+
+#endif /* _MAX32620FTHR_H_ */