Fork of Library for MAXREFDES72# that supports configuration of shield for different PMOD types and the DS3231 RTC
Fork of ard2pmod by
ard2pmod.h@17:294c52822d28, 2016-03-29 (annotated)
- Committer:
- j3
- Date:
- Tue Mar 29 01:22:08 2016 +0000
- Revision:
- 17:294c52822d28
- Parent:
- 16:abb327ca5580
- Child:
- 18:6d82914432e2
updated Ds3231 and Max14661 libraries
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
j3 | 0:bb62cd328247 | 1 | /******************************************************************//** |
j3 | 15:014ab2d734e0 | 2 | * Copyright (C) 2015 Maxim Integrated Products, Inc., All Rights Reserved. |
j3 | 0:bb62cd328247 | 3 | * |
j3 | 0:bb62cd328247 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a |
j3 | 0:bb62cd328247 | 5 | * copy of this software and associated documentation files (the "Software"), |
j3 | 0:bb62cd328247 | 6 | * to deal in the Software without restriction, including without limitation |
j3 | 0:bb62cd328247 | 7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
j3 | 0:bb62cd328247 | 8 | * and/or sell copies of the Software, and to permit persons to whom the |
j3 | 0:bb62cd328247 | 9 | * Software is furnished to do so, subject to the following conditions: |
j3 | 0:bb62cd328247 | 10 | * |
j3 | 0:bb62cd328247 | 11 | * The above copyright notice and this permission notice shall be included |
j3 | 0:bb62cd328247 | 12 | * in all copies or substantial portions of the Software. |
j3 | 0:bb62cd328247 | 13 | * |
j3 | 0:bb62cd328247 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
j3 | 0:bb62cd328247 | 15 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
j3 | 0:bb62cd328247 | 16 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
j3 | 0:bb62cd328247 | 17 | * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
j3 | 0:bb62cd328247 | 18 | * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
j3 | 0:bb62cd328247 | 19 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
j3 | 0:bb62cd328247 | 20 | * OTHER DEALINGS IN THE SOFTWARE. |
j3 | 0:bb62cd328247 | 21 | * |
j3 | 0:bb62cd328247 | 22 | * Except as contained in this notice, the name of Maxim Integrated |
j3 | 0:bb62cd328247 | 23 | * Products, Inc. shall not be used except as stated in the Maxim Integrated |
j3 | 0:bb62cd328247 | 24 | * Products, Inc. Branding Policy. |
j3 | 0:bb62cd328247 | 25 | * |
j3 | 0:bb62cd328247 | 26 | * The mere transfer of this software does not imply any licenses |
j3 | 0:bb62cd328247 | 27 | * of trade secrets, proprietary technology, copyrights, patents, |
j3 | 0:bb62cd328247 | 28 | * trademarks, maskwork rights, or any other form of intellectual |
j3 | 0:bb62cd328247 | 29 | * property whatsoever. Maxim Integrated Products, Inc. retains all |
j3 | 0:bb62cd328247 | 30 | * ownership rights. |
j3 | 0:bb62cd328247 | 31 | **********************************************************************/ |
j3 | 0:bb62cd328247 | 32 | |
j3 | 0:bb62cd328247 | 33 | |
j3 | 0:bb62cd328247 | 34 | #ifndef ARD2PMOD_H |
j3 | 0:bb62cd328247 | 35 | #define ARD2PMOD_H |
j3 | 0:bb62cd328247 | 36 | |
j3 | 0:bb62cd328247 | 37 | |
j3 | 0:bb62cd328247 | 38 | #include "mbed.h" |
j3 | 0:bb62cd328247 | 39 | #include "max14661.h" |
j3 | 0:bb62cd328247 | 40 | #include "ds3231.h" |
j3 | 0:bb62cd328247 | 41 | |
j3 | 0:bb62cd328247 | 42 | |
j3 | 0:bb62cd328247 | 43 | /******************************************************************//** |
j3 | 0:bb62cd328247 | 44 | * Ard2Pmod Class |
j3 | 0:bb62cd328247 | 45 | * Used for establishing PMOD type, MAX14661 16:2 mux, |
j3 | 0:bb62cd328247 | 46 | * and DS3231 RTC interface |
j3 | 0:bb62cd328247 | 47 | * |
j3 | 0:bb62cd328247 | 48 | * Please See MAXREFDES72# pcb schematic for constraints. |
j3 | 0:bb62cd328247 | 49 | * |
j3 | 4:349f2ec17a4b | 50 | * PMOD_TYPE_I2C_A - |
j3 | 4:349f2ec17a4b | 51 | * Switches SWA9, SWA12 and SWB10, SWB11 closed. All other switches |
j3 | 4:349f2ec17a4b | 52 | * open |
j3 | 4:349f2ec17a4b | 53 | * |
j3 | 4:349f2ec17a4b | 54 | * PMOD_TYPE_I2C_B - |
j3 | 4:349f2ec17a4b | 55 | * Switches SWA9, SWA7 and SWB10, SWB8 closed. All other switches |
j3 | 4:349f2ec17a4b | 56 | * open |
j3 | 4:349f2ec17a4b | 57 | * |
j3 | 4:349f2ec17a4b | 58 | * PMOD_TYPE_I2C_AB - |
j3 | 0:bb62cd328247 | 59 | * Switches SWA7, SWA9, SWA12 and SWB8, SWB10, SWB11 closed. All other |
j3 | 0:bb62cd328247 | 60 | * switches open |
j3 | 0:bb62cd328247 | 61 | * |
j3 | 0:bb62cd328247 | 62 | * PMOD_TYPE_1_GPIO - |
j3 | 0:bb62cd328247 | 63 | * Switches all open, mux not used |
j3 | 0:bb62cd328247 | 64 | * |
j3 | 0:bb62cd328247 | 65 | * PMOD_TYPE_2_SPI - |
j3 | 0:bb62cd328247 | 66 | * Switches all open, mux not used |
j3 | 0:bb62cd328247 | 67 | * |
j3 | 0:bb62cd328247 | 68 | * PMOD_TYPE_3_UART - |
j3 | 13:41ebe12b9492 | 69 | * Switches SWA12, SWA1, SWB11, SWB2 closed. All other switches open. |
j3 | 0:bb62cd328247 | 70 | * |
j3 | 0:bb62cd328247 | 71 | * PMOD_TYPE_4_UART - |
j3 | 13:41ebe12b9492 | 72 | * Switches SWA13, SWA2, SWB12, SWB1 closed. All other switches open. |
j3 | 0:bb62cd328247 | 73 | * |
j3 | 0:bb62cd328247 | 74 | * PMOD_TYPE_5_HBRIDGE - |
j3 | 0:bb62cd328247 | 75 | * Switches all open, mux not used |
j3 | 0:bb62cd328247 | 76 | * |
j3 | 0:bb62cd328247 | 77 | * PMOD_TYPE_6_HBRIDGE - |
j3 | 0:bb62cd328247 | 78 | * Switches all open, mux not used |
j3 | 0:bb62cd328247 | 79 | **********************************************************************/ |
j3 | 17:294c52822d28 | 80 | class Ard2Pmod |
j3 | 0:bb62cd328247 | 81 | { |
j3 | 0:bb62cd328247 | 82 | public: |
j3 | 16:abb327ca5580 | 83 | |
j3 | 16:abb327ca5580 | 84 | /** |
j3 | 16:abb327ca5580 | 85 | * pmod_type_t - enumerated PMOD types |
j3 | 16:abb327ca5580 | 86 | */ |
j3 | 16:abb327ca5580 | 87 | typedef enum |
j3 | 16:abb327ca5580 | 88 | { |
j3 | 16:abb327ca5580 | 89 | PMOD_TYPE_I2C_A, |
j3 | 16:abb327ca5580 | 90 | PMOD_TYPE_I2C_B, |
j3 | 16:abb327ca5580 | 91 | PMOD_TYPE_I2C_AB, |
j3 | 16:abb327ca5580 | 92 | PMOD_TYPE_1_GPIO, |
j3 | 16:abb327ca5580 | 93 | PMOD_TYPE_2_SPI, |
j3 | 16:abb327ca5580 | 94 | PMOD_TYPE_3_UART, |
j3 | 16:abb327ca5580 | 95 | PMOD_TYPE_4_UART, |
j3 | 16:abb327ca5580 | 96 | PMOD_TYPE_5_HBRIDGE, |
j3 | 16:abb327ca5580 | 97 | PMOD_TYPE_6_HBRIDGE |
j3 | 16:abb327ca5580 | 98 | }pmod_type_t; |
j3 | 16:abb327ca5580 | 99 | |
j3 | 16:abb327ca5580 | 100 | |
j3 | 6:9e75c6a2dff5 | 101 | /**************************************************************//** |
j3 | 6:9e75c6a2dff5 | 102 | * Default constructor for Ard2Pmod Class, all mux switches open |
j3 | 6:9e75c6a2dff5 | 103 | * Use with Max14661 member functions for custom mux settings |
j3 | 6:9e75c6a2dff5 | 104 | * |
j3 | 6:9e75c6a2dff5 | 105 | * On Entry: |
j3 | 6:9e75c6a2dff5 | 106 | * |
j3 | 6:9e75c6a2dff5 | 107 | * On Exit: |
j3 | 6:9e75c6a2dff5 | 108 | * @return none |
j3 | 6:9e75c6a2dff5 | 109 | * |
j3 | 6:9e75c6a2dff5 | 110 | * Example: |
j3 | 6:9e75c6a2dff5 | 111 | * @code |
j3 | 6:9e75c6a2dff5 | 112 | * #include "ard2pmod.h" |
j3 | 6:9e75c6a2dff5 | 113 | * |
j3 | 6:9e75c6a2dff5 | 114 | * int main(void) |
j3 | 6:9e75c6a2dff5 | 115 | * { |
j3 | 7:d3881d2c2d6b | 116 | * Ard2Pmod ard2pmod; |
j3 | 6:9e75c6a2dff5 | 117 | * |
j3 | 6:9e75c6a2dff5 | 118 | * //main app. |
j3 | 6:9e75c6a2dff5 | 119 | * for(;;) |
j3 | 6:9e75c6a2dff5 | 120 | * { |
j3 | 6:9e75c6a2dff5 | 121 | * } |
j3 | 6:9e75c6a2dff5 | 122 | * } |
j3 | 6:9e75c6a2dff5 | 123 | * @endcode |
j3 | 6:9e75c6a2dff5 | 124 | ******************************************************************/ |
j3 | 6:9e75c6a2dff5 | 125 | Ard2Pmod(); |
j3 | 6:9e75c6a2dff5 | 126 | |
j3 | 6:9e75c6a2dff5 | 127 | |
j3 | 0:bb62cd328247 | 128 | /**************************************************************//** |
j3 | 0:bb62cd328247 | 129 | * Constructor for Ard2Pmod Class |
j3 | 0:bb62cd328247 | 130 | * |
j3 | 0:bb62cd328247 | 131 | * On Entry: |
j3 | 0:bb62cd328247 | 132 | * @param[in] pmod_type - desired PMOD interface |
j3 | 0:bb62cd328247 | 133 | * |
j3 | 0:bb62cd328247 | 134 | * On Exit: |
j3 | 0:bb62cd328247 | 135 | * @return none |
j3 | 0:bb62cd328247 | 136 | * |
j3 | 0:bb62cd328247 | 137 | * Example: |
j3 | 0:bb62cd328247 | 138 | * @code |
j3 | 0:bb62cd328247 | 139 | * #include "ard2pmod.h" |
j3 | 0:bb62cd328247 | 140 | * |
j3 | 0:bb62cd328247 | 141 | * int main(void) |
j3 | 0:bb62cd328247 | 142 | * { |
j3 | 0:bb62cd328247 | 143 | * Ard2Pmod ard2pmod(PMOD_TYPE_1_GPIO); |
j3 | 0:bb62cd328247 | 144 | * |
j3 | 0:bb62cd328247 | 145 | * //main app. |
j3 | 0:bb62cd328247 | 146 | * for(;;) |
j3 | 0:bb62cd328247 | 147 | * { |
j3 | 0:bb62cd328247 | 148 | * } |
j3 | 0:bb62cd328247 | 149 | * } |
j3 | 0:bb62cd328247 | 150 | * @endcode |
j3 | 0:bb62cd328247 | 151 | ******************************************************************/ |
j3 | 0:bb62cd328247 | 152 | Ard2Pmod(pmod_type_t pmod_type); |
j3 | 17:294c52822d28 | 153 | |
j3 | 17:294c52822d28 | 154 | private: |
j3 | 17:294c52822d28 | 155 | |
j3 | 17:294c52822d28 | 156 | Max14661 _mux; |
j3 | 0:bb62cd328247 | 157 | |
j3 | 0:bb62cd328247 | 158 | }; |
j3 | 0:bb62cd328247 | 159 | |
j3 | 0:bb62cd328247 | 160 | |
j3 | 0:bb62cd328247 | 161 | #endif /* ARD2PMOD_H*/ |