Maxim Integrated / ard2pmod

Library for MAXREFDES72# that supports configuration of shield for different PMOD types and the DS3231 RTC

Dependencies:   ds3231 max14661

Dependents:   ard2pmod_demo max14724_hello_world ALS_Proximity_Demo

Ard2Pmod Shield Component Page

ard2pmod.cpp@16:abb327ca5580, 2015-03-19 (annotated)

Committer:
j3
Date:
Thu Mar 19 21:53:04 2015 +0000
Revision:
16:abb327ca5580
Parent:
15:014ab2d734e0 
moved enum into class, updated max14661 and ds3231 libs

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 0:bb62cd328247 1 /******************************************************************//**
j3 0:bb62cd328247 2 * @file ard2pmod.cpp
j3 0:bb62cd328247 3 *
j3 0:bb62cd328247 4 * @author Justin Jordan
j3 0:bb62cd328247 5 *
j3 14:ddd423459248 6 * @version 1.0
j3 0:bb62cd328247 7 *
j3 0:bb62cd328247 8 * Started: 11NOV14
j3 0:bb62cd328247 9 *
j3 0:bb62cd328247 10 * Updated:
j3 0:bb62cd328247 11 *
j3 0:bb62cd328247 12 * @brief Source file for ard2pmod class
j3 0:bb62cd328247 13 *
j3 0:bb62cd328247 14 ***********************************************************************
j3 0:bb62cd328247 15 *
j3 0:bb62cd328247 16 * @copyright
j3 15:014ab2d734e0 17 * Copyright (C) 2015 Maxim Integrated Products, Inc., All Rights Reserved.
j3 0:bb62cd328247 18 *
j3 0:bb62cd328247 19 * Permission is hereby granted, free of charge, to any person obtaining a
j3 0:bb62cd328247 20 * copy of this software and associated documentation files (the "Software"),
j3 0:bb62cd328247 21 * to deal in the Software without restriction, including without limitation
j3 0:bb62cd328247 22 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 0:bb62cd328247 23 * and/or sell copies of the Software, and to permit persons to whom the
j3 0:bb62cd328247 24 * Software is furnished to do so, subject to the following conditions:
j3 0:bb62cd328247 25 *
j3 0:bb62cd328247 26 * The above copyright notice and this permission notice shall be included
j3 0:bb62cd328247 27 * in all copies or substantial portions of the Software.
j3 0:bb62cd328247 28 *
j3 0:bb62cd328247 29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 0:bb62cd328247 30 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 0:bb62cd328247 31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 0:bb62cd328247 32 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 0:bb62cd328247 33 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 0:bb62cd328247 34 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 0:bb62cd328247 35 * OTHER DEALINGS IN THE SOFTWARE.
j3 0:bb62cd328247 36 *
j3 0:bb62cd328247 37 * Except as contained in this notice, the name of Maxim Integrated
j3 0:bb62cd328247 38 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 0:bb62cd328247 39 * Products, Inc. Branding Policy.
j3 0:bb62cd328247 40 *
j3 0:bb62cd328247 41 * The mere transfer of this software does not imply any licenses
j3 0:bb62cd328247 42 * of trade secrets, proprietary technology, copyrights, patents,
j3 0:bb62cd328247 43 * trademarks, maskwork rights, or any other form of intellectual
j3 0:bb62cd328247 44 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 0:bb62cd328247 45 * ownership rights.
j3 0:bb62cd328247 46 **********************************************************************/
j3 0:bb62cd328247 47
j3 0:bb62cd328247 48
j3 0:bb62cd328247 49 #include "ard2pmod.h"
j3 0:bb62cd328247 50
j3 0:bb62cd328247 51
j3 0:bb62cd328247 52 /**************************************************************//**
j3 6:9e75c6a2dff5 53 * Default constructor for Ard2Pmod Class, all mux switches open
j3 6:9e75c6a2dff5 54 * Use with Max14661 member functions for custom mux settings
j3 6:9e75c6a2dff5 55 *
j3 6:9e75c6a2dff5 56 * On Entry:
j3 6:9e75c6a2dff5 57 *
j3 6:9e75c6a2dff5 58 * On Exit:
j3 6:9e75c6a2dff5 59 * @return none
j3 6:9e75c6a2dff5 60 *
j3 6:9e75c6a2dff5 61 * Example:
j3 6:9e75c6a2dff5 62 * @code
j3 6:9e75c6a2dff5 63 * #include "ard2pmod.h"
j3 6:9e75c6a2dff5 64 *
j3 6:9e75c6a2dff5 65 * int main(void)
j3 6:9e75c6a2dff5 66 * {
j3 7:d3881d2c2d6b 67 * Ard2Pmod ard2pmod;
j3 6:9e75c6a2dff5 68 *
j3 6:9e75c6a2dff5 69 * //main app.
j3 6:9e75c6a2dff5 70 * for(;;)
j3 6:9e75c6a2dff5 71 * {
j3 6:9e75c6a2dff5 72 * }
j3 6:9e75c6a2dff5 73 * }
j3 6:9e75c6a2dff5 74 * @endcode
j3 6:9e75c6a2dff5 75 ******************************************************************/
j3 6:9e75c6a2dff5 76 Ard2Pmod::Ard2Pmod() :
j3 6:9e75c6a2dff5 77 Max14661(ARD2PMOD_SDA, ARD2PMOD_SCL, MAX14661_I2C_ADRS0),
j3 6:9e75c6a2dff5 78 Ds3231(ARD2PMOD_SDA, ARD2PMOD_SCL)
j3 6:9e75c6a2dff5 79 {
j3 6:9e75c6a2dff5 80 wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 6:9e75c6a2dff5 81 }
j3 6:9e75c6a2dff5 82
j3 6:9e75c6a2dff5 83
j3 6:9e75c6a2dff5 84 /**************************************************************//**
j3 0:bb62cd328247 85 * Constructor for Ard2Pmod Class
j3 0:bb62cd328247 86 *
j3 0:bb62cd328247 87 * On Entry:
j3 0:bb62cd328247 88 * @param[in] pmod_type - desired PMOD interface
j3 0:bb62cd328247 89 *
j3 0:bb62cd328247 90 * On Exit:
j3 0:bb62cd328247 91 * @return none
j3 0:bb62cd328247 92 *
j3 0:bb62cd328247 93 * Example:
j3 0:bb62cd328247 94 * @code
j3 0:bb62cd328247 95 * #include "ard2pmod.h"
j3 0:bb62cd328247 96 *
j3 0:bb62cd328247 97 * int main(void)
j3 0:bb62cd328247 98 * {
j3 0:bb62cd328247 99 * Ard2Pmod ard2pmod(PMOD_TYPE_1_GPIO);
j3 0:bb62cd328247 100 *
j3 0:bb62cd328247 101 * //main app.
j3 0:bb62cd328247 102 * for(;;)
j3 0:bb62cd328247 103 * {
j3 0:bb62cd328247 104 * }
j3 0:bb62cd328247 105 * }
j3 0:bb62cd328247 106 * @endcode
j3 0:bb62cd328247 107 ******************************************************************/
j3 0:bb62cd328247 108 Ard2Pmod::Ard2Pmod(pmod_type_t pmod_type) :
j3 0:bb62cd328247 109 Max14661(ARD2PMOD_SDA, ARD2PMOD_SCL, MAX14661_I2C_ADRS0),
j3 0:bb62cd328247 110 Ds3231(ARD2PMOD_SDA, ARD2PMOD_SCL)
j3 0:bb62cd328247 111 {
j3 0:bb62cd328247 112 switch(pmod_type)
j3 0:bb62cd328247 113 {
j3 3:64d54fa4dd3c 114 case PMOD_TYPE_I2C_A:
j3 3:64d54fa4dd3c 115 set_switches((SW12 | SW09), (SW11 | SW10));
j3 3:64d54fa4dd3c 116 break;
j3 3:64d54fa4dd3c 117
j3 3:64d54fa4dd3c 118 case PMOD_TYPE_I2C_B:
j3 3:64d54fa4dd3c 119 set_switches((SW09 | SW07), (SW10 | SW08));
j3 3:64d54fa4dd3c 120 break;
j3 3:64d54fa4dd3c 121
j3 3:64d54fa4dd3c 122 case PMOD_TYPE_I2C_AB:
j3 2:686912ed055f 123 set_switches((SW12 | SW09 | SW07), (SW11 | SW10 | SW08));
j3 0:bb62cd328247 124 break;
j3 0:bb62cd328247 125
j3 0:bb62cd328247 126 case PMOD_TYPE_1_GPIO:
j3 0:bb62cd328247 127 wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 0:bb62cd328247 128 break;
j3 0:bb62cd328247 129
j3 0:bb62cd328247 130 case PMOD_TYPE_2_SPI:
j3 0:bb62cd328247 131 wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 0:bb62cd328247 132 break;
j3 0:bb62cd328247 133
j3 0:bb62cd328247 134 case PMOD_TYPE_3_UART:
j3 12:6be7e55a48c3 135 set_switches((SW12 | SW01), (SW11 | SW02));
j3 0:bb62cd328247 136 break;
j3 0:bb62cd328247 137
j3 0:bb62cd328247 138 case PMOD_TYPE_4_UART:
j3 12:6be7e55a48c3 139 set_switches((SW13 | SW02), (SW12 | SW01));
j3 0:bb62cd328247 140 break;
j3 0:bb62cd328247 141
j3 0:bb62cd328247 142 case PMOD_TYPE_5_HBRIDGE:
j3 0:bb62cd328247 143 wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 0:bb62cd328247 144 break;
j3 0:bb62cd328247 145
j3 0:bb62cd328247 146 case PMOD_TYPE_6_HBRIDGE:
j3 0:bb62cd328247 147 wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 0:bb62cd328247 148 break;
j3 0:bb62cd328247 149
j3 0:bb62cd328247 150 default:
j3 0:bb62cd328247 151 wrt_cmd_registers(DISABLE_BANK, DISABLE_BANK);
j3 0:bb62cd328247 152 }
j3 0:bb62cd328247 153
j3 0:bb62cd328247 154 }
j3 0:bb62cd328247 155
j3 0:bb62cd328247 156