Library for MAX77756. The MAX77756 is a synchronous 500mA step-down DC-DC converter with integrated dual-input power multiplexer(MUX).
Fork of max77756 by
max77756.h@0:fc290eb62889, 2017-09-14 (annotated)
- Committer:
- daniel_gs_jeong
- Date:
- Thu Sep 14 15:02:47 2017 +0000
- Revision:
- 0:fc290eb62889
Initial Version of MAX77756 Library;
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
daniel_gs_jeong | 0:fc290eb62889 | 1 | /******************************************************************************* |
daniel_gs_jeong | 0:fc290eb62889 | 2 | * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved. |
daniel_gs_jeong | 0:fc290eb62889 | 3 | * |
daniel_gs_jeong | 0:fc290eb62889 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a |
daniel_gs_jeong | 0:fc290eb62889 | 5 | * copy of this software and associated documentation files (the "Software"), |
daniel_gs_jeong | 0:fc290eb62889 | 6 | * to deal in the Software without restriction, including without limitation |
daniel_gs_jeong | 0:fc290eb62889 | 7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
daniel_gs_jeong | 0:fc290eb62889 | 8 | * and/or sell copies of the Software, and to permit persons to whom the |
daniel_gs_jeong | 0:fc290eb62889 | 9 | * Software is furnished to do so, subject to the following conditions: |
daniel_gs_jeong | 0:fc290eb62889 | 10 | * |
daniel_gs_jeong | 0:fc290eb62889 | 11 | * The above copyright notice and this permission notice shall be included |
daniel_gs_jeong | 0:fc290eb62889 | 12 | * in all copies or substantial portions of the Software. |
daniel_gs_jeong | 0:fc290eb62889 | 13 | * |
daniel_gs_jeong | 0:fc290eb62889 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
daniel_gs_jeong | 0:fc290eb62889 | 15 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
daniel_gs_jeong | 0:fc290eb62889 | 16 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
daniel_gs_jeong | 0:fc290eb62889 | 17 | * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
daniel_gs_jeong | 0:fc290eb62889 | 18 | * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
daniel_gs_jeong | 0:fc290eb62889 | 19 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
daniel_gs_jeong | 0:fc290eb62889 | 20 | * OTHER DEALINGS IN THE SOFTWARE. |
daniel_gs_jeong | 0:fc290eb62889 | 21 | * |
daniel_gs_jeong | 0:fc290eb62889 | 22 | * Except as contained in this notice, the name of Maxim Integrated |
daniel_gs_jeong | 0:fc290eb62889 | 23 | * Products, Inc. shall not be used except as stated in the Maxim Integrated |
daniel_gs_jeong | 0:fc290eb62889 | 24 | * Products, Inc. Branding Policy. |
daniel_gs_jeong | 0:fc290eb62889 | 25 | * |
daniel_gs_jeong | 0:fc290eb62889 | 26 | * The mere transfer of this software does not imply any licenses |
daniel_gs_jeong | 0:fc290eb62889 | 27 | * of trade secrets, proprietary technology, copyrights, patents, |
daniel_gs_jeong | 0:fc290eb62889 | 28 | * trademarks, maskwork rights, or any other form of intellectual |
daniel_gs_jeong | 0:fc290eb62889 | 29 | * property whatsoever. Maxim Integrated Products, Inc. retains all |
daniel_gs_jeong | 0:fc290eb62889 | 30 | * ownership rights. |
daniel_gs_jeong | 0:fc290eb62889 | 31 | ******************************************************************************* |
daniel_gs_jeong | 0:fc290eb62889 | 32 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 33 | |
daniel_gs_jeong | 0:fc290eb62889 | 34 | #ifndef _MAX77756_H_ |
daniel_gs_jeong | 0:fc290eb62889 | 35 | #define _MAX77756_H_ |
daniel_gs_jeong | 0:fc290eb62889 | 36 | |
daniel_gs_jeong | 0:fc290eb62889 | 37 | #include "mbed.h" |
daniel_gs_jeong | 0:fc290eb62889 | 38 | |
daniel_gs_jeong | 0:fc290eb62889 | 39 | class MAX77756 |
daniel_gs_jeong | 0:fc290eb62889 | 40 | { |
daniel_gs_jeong | 0:fc290eb62889 | 41 | |
daniel_gs_jeong | 0:fc290eb62889 | 42 | public: |
daniel_gs_jeong | 0:fc290eb62889 | 43 | |
daniel_gs_jeong | 0:fc290eb62889 | 44 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 45 | * @brief Register Addresses |
daniel_gs_jeong | 0:fc290eb62889 | 46 | * @details Enumerated MAX77756 register addresses |
daniel_gs_jeong | 0:fc290eb62889 | 47 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 48 | typedef enum { |
daniel_gs_jeong | 0:fc290eb62889 | 49 | REG_CONFIGA = 0x00, |
daniel_gs_jeong | 0:fc290eb62889 | 50 | REG_CONFIGB |
daniel_gs_jeong | 0:fc290eb62889 | 51 | } registers_t; |
daniel_gs_jeong | 0:fc290eb62889 | 52 | |
daniel_gs_jeong | 0:fc290eb62889 | 53 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 54 | * @brief Spread Spectrum Control |
daniel_gs_jeong | 0:fc290eb62889 | 55 | * @details Enumerated Spread Spectrum Module |
daniel_gs_jeong | 0:fc290eb62889 | 56 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 57 | typedef enum { |
daniel_gs_jeong | 0:fc290eb62889 | 58 | S_SPECTRUM_OFF = 0x00, |
daniel_gs_jeong | 0:fc290eb62889 | 59 | S_SPECTRUM_ON |
daniel_gs_jeong | 0:fc290eb62889 | 60 | } SpreadSpectrum_t; |
daniel_gs_jeong | 0:fc290eb62889 | 61 | |
daniel_gs_jeong | 0:fc290eb62889 | 62 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 63 | * @brief Soft Start Control |
daniel_gs_jeong | 0:fc290eb62889 | 64 | * @details Enumerated Start-Up Ramp Time for the Regulator |
daniel_gs_jeong | 0:fc290eb62889 | 65 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 66 | typedef enum { |
daniel_gs_jeong | 0:fc290eb62889 | 67 | S_START_8_ms = 0x00, |
daniel_gs_jeong | 0:fc290eb62889 | 68 | S_START_4ms |
daniel_gs_jeong | 0:fc290eb62889 | 69 | } SoftStart_t; |
daniel_gs_jeong | 0:fc290eb62889 | 70 | |
daniel_gs_jeong | 0:fc290eb62889 | 71 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 72 | * @brief Peak Current Limit |
daniel_gs_jeong | 0:fc290eb62889 | 73 | * @details Enumerated High Side DMOS Peak Current Limit |
daniel_gs_jeong | 0:fc290eb62889 | 74 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 75 | typedef enum { |
daniel_gs_jeong | 0:fc290eb62889 | 76 | I_PEAK_LIMIT_700_mA = 0x00, |
daniel_gs_jeong | 0:fc290eb62889 | 77 | I_PEAK_LIMIT_800_mA, |
daniel_gs_jeong | 0:fc290eb62889 | 78 | I_PEAK_LIMIT_900_mA, |
daniel_gs_jeong | 0:fc290eb62889 | 79 | I_PEAK_LIMIT_1000_mA |
daniel_gs_jeong | 0:fc290eb62889 | 80 | } PeakCurrent_t; |
daniel_gs_jeong | 0:fc290eb62889 | 81 | |
daniel_gs_jeong | 0:fc290eb62889 | 82 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 83 | * @brief Enable Logic |
daniel_gs_jeong | 0:fc290eb62889 | 84 | * @details Enumerated Enable Logic Control between EN_BIT and EN Pin |
daniel_gs_jeong | 0:fc290eb62889 | 85 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 86 | typedef enum { |
daniel_gs_jeong | 0:fc290eb62889 | 87 | EN_LOGICAL_OR = 0x00, |
daniel_gs_jeong | 0:fc290eb62889 | 88 | EN_LOGICAL_AND |
daniel_gs_jeong | 0:fc290eb62889 | 89 | } EnableLogic_t; |
daniel_gs_jeong | 0:fc290eb62889 | 90 | |
daniel_gs_jeong | 0:fc290eb62889 | 91 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 92 | * @brief Enable Bit |
daniel_gs_jeong | 0:fc290eb62889 | 93 | * @details Enumerated Enable for Regulator |
daniel_gs_jeong | 0:fc290eb62889 | 94 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 95 | typedef enum { |
daniel_gs_jeong | 0:fc290eb62889 | 96 | ENABLE = 0x00, |
daniel_gs_jeong | 0:fc290eb62889 | 97 | DISABLE |
daniel_gs_jeong | 0:fc290eb62889 | 98 | } Enable_t; |
daniel_gs_jeong | 0:fc290eb62889 | 99 | |
daniel_gs_jeong | 0:fc290eb62889 | 100 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 101 | * MAX77756 constructor. |
daniel_gs_jeong | 0:fc290eb62889 | 102 | * |
daniel_gs_jeong | 0:fc290eb62889 | 103 | * @param sda mbed pin to use for SDA line of I2C interface. |
daniel_gs_jeong | 0:fc290eb62889 | 104 | * @param scl mbed pin to use for SCL line of I2C interface. |
daniel_gs_jeong | 0:fc290eb62889 | 105 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 106 | MAX77756(PinName sda, PinName scl); |
daniel_gs_jeong | 0:fc290eb62889 | 107 | |
daniel_gs_jeong | 0:fc290eb62889 | 108 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 109 | * MAX77756 constructor. |
daniel_gs_jeong | 0:fc290eb62889 | 110 | * |
daniel_gs_jeong | 0:fc290eb62889 | 111 | * @param i2c I2C object to use. |
daniel_gs_jeong | 0:fc290eb62889 | 112 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 113 | MAX77756(I2C *i2c); |
daniel_gs_jeong | 0:fc290eb62889 | 114 | |
daniel_gs_jeong | 0:fc290eb62889 | 115 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 116 | * MAX44000 destructor. |
daniel_gs_jeong | 0:fc290eb62889 | 117 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 118 | ~MAX77756(); |
daniel_gs_jeong | 0:fc290eb62889 | 119 | |
daniel_gs_jeong | 0:fc290eb62889 | 120 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 121 | * @brief Initialize MAX77756 |
daniel_gs_jeong | 0:fc290eb62889 | 122 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 123 | int32_t init(); |
daniel_gs_jeong | 0:fc290eb62889 | 124 | |
daniel_gs_jeong | 0:fc290eb62889 | 125 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 126 | * @brief Write Register |
daniel_gs_jeong | 0:fc290eb62889 | 127 | * @details Writes data to MAX77756 register |
daniel_gs_jeong | 0:fc290eb62889 | 128 | * |
daniel_gs_jeong | 0:fc290eb62889 | 129 | * @param reg_addr Register to write |
daniel_gs_jeong | 0:fc290eb62889 | 130 | * @param reg_data Data to write |
daniel_gs_jeong | 0:fc290eb62889 | 131 | * @returns 0 if no errors, -1 if error. |
daniel_gs_jeong | 0:fc290eb62889 | 132 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 133 | int32_t writeReg(MAX77756::registers_t reg_addr, char reg_data); |
daniel_gs_jeong | 0:fc290eb62889 | 134 | |
daniel_gs_jeong | 0:fc290eb62889 | 135 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 136 | * @brief Read Register |
daniel_gs_jeong | 0:fc290eb62889 | 137 | * @details Reads data from MAX77756 register |
daniel_gs_jeong | 0:fc290eb62889 | 138 | * |
daniel_gs_jeong | 0:fc290eb62889 | 139 | * @param reg_addr Register to read |
daniel_gs_jeong | 0:fc290eb62889 | 140 | * @returns data if no errors, -1 if error. |
daniel_gs_jeong | 0:fc290eb62889 | 141 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 142 | int32_t readReg(MAX77756::registers_t reg_addr); |
daniel_gs_jeong | 0:fc290eb62889 | 143 | |
daniel_gs_jeong | 0:fc290eb62889 | 144 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 145 | * @brief Regultor Enable |
daniel_gs_jeong | 0:fc290eb62889 | 146 | * @details Control EN_BIT to Enable/Disable Regulator |
daniel_gs_jeong | 0:fc290eb62889 | 147 | * |
daniel_gs_jeong | 0:fc290eb62889 | 148 | * @param enable value to control |
daniel_gs_jeong | 0:fc290eb62889 | 149 | * @returns 0 if no errors, -1 if error. |
daniel_gs_jeong | 0:fc290eb62889 | 150 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 151 | int32_t outEnable(MAX77756::Enable_t enable); |
daniel_gs_jeong | 0:fc290eb62889 | 152 | |
daniel_gs_jeong | 0:fc290eb62889 | 153 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 154 | * @brief Set Output Voltage |
daniel_gs_jeong | 0:fc290eb62889 | 155 | * @details Control Output Voltage. |
daniel_gs_jeong | 0:fc290eb62889 | 156 | * |
daniel_gs_jeong | 0:fc290eb62889 | 157 | * @param Output Voltage from 1500 to 7500 (mV) |
daniel_gs_jeong | 0:fc290eb62889 | 158 | * @returns 0 if no errors, -1 if error. |
daniel_gs_jeong | 0:fc290eb62889 | 159 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 160 | int32_t setVout(uint32_t outVoltage); |
daniel_gs_jeong | 0:fc290eb62889 | 161 | |
daniel_gs_jeong | 0:fc290eb62889 | 162 | /** |
daniel_gs_jeong | 0:fc290eb62889 | 163 | * @brief Config MAX77756 |
daniel_gs_jeong | 0:fc290eb62889 | 164 | * @details Set Spread-Spectrum, SoftStart, Peak Current and Enable Logic. |
daniel_gs_jeong | 0:fc290eb62889 | 165 | * |
daniel_gs_jeong | 0:fc290eb62889 | 166 | * @param Spread Spectrum Configuration Value |
daniel_gs_jeong | 0:fc290eb62889 | 167 | * @param Soft Start Configuration Value |
daniel_gs_jeong | 0:fc290eb62889 | 168 | * @param High Side DMOS Peak Current Configuration Value |
daniel_gs_jeong | 0:fc290eb62889 | 169 | * @param Enable Logic Configuration Value |
daniel_gs_jeong | 0:fc290eb62889 | 170 | * @returns 0 if no errors, -1 if error. |
daniel_gs_jeong | 0:fc290eb62889 | 171 | */ |
daniel_gs_jeong | 0:fc290eb62889 | 172 | int32_t config(MAX77756::SpreadSpectrum_t sspectrum, |
daniel_gs_jeong | 0:fc290eb62889 | 173 | MAX77756::SoftStart_t sstart, |
daniel_gs_jeong | 0:fc290eb62889 | 174 | MAX77756::PeakCurrent_t ipeak, |
daniel_gs_jeong | 0:fc290eb62889 | 175 | MAX77756::EnableLogic_t enlogic); |
daniel_gs_jeong | 0:fc290eb62889 | 176 | |
daniel_gs_jeong | 0:fc290eb62889 | 177 | private: |
daniel_gs_jeong | 0:fc290eb62889 | 178 | |
daniel_gs_jeong | 0:fc290eb62889 | 179 | I2C *i2c_; |
daniel_gs_jeong | 0:fc290eb62889 | 180 | bool i2c_owner; |
daniel_gs_jeong | 0:fc290eb62889 | 181 | |
daniel_gs_jeong | 0:fc290eb62889 | 182 | }; |
daniel_gs_jeong | 0:fc290eb62889 | 183 | |
daniel_gs_jeong | 0:fc290eb62889 | 184 | #endif /* _MAX77756_H_ */ |
daniel_gs_jeong | 0:fc290eb62889 | 185 |