Diff: ard2pmod.h

Revision:

0:bb62cd328247

Child:

3:64d54fa4dd3c

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ard2pmod.h	Thu Nov 20 21:10:15 2014 +0000
@@ -0,0 +1,135 @@
+/******************************************************************//**
+* @file ard2pmod.h
+*
+* @author Justin Jordan
+*
+* @version 0.0
+*
+* Started: 11NOV14
+*
+* Updated: 
+*
+* @brief Header file for ard2pmod class
+*
+***********************************************************************
+*
+* @copyright 
+* Copyright (C) 2013 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 ARD2PMOD_H
+#define ARD2PMOD_H
+
+
+#include "mbed.h"
+#include "max14661.h"
+#include "ds3231.h"
+
+
+#define ARD2PMOD_SDA D14
+#define ARD2PMOD_SCL D15
+
+
+typedef enum
+{
+	PMOD_TYPE_I2C,
+	PMOD_TYPE_1_GPIO,
+	PMOD_TYPE_2_SPI,
+	PMOD_TYPE_3_UART,
+	PMOD_TYPE_4_UART,
+	PMOD_TYPE_5_HBRIDGE,
+	PMOD_TYPE_6_HBRIDGE
+}pmod_type_t;
+	
+	
+/******************************************************************//**
+* Ard2Pmod Class
+* Used for establishing PMOD type, MAX14661 16:2 mux, 
+* and DS3231 RTC interface
+*
+* Please See MAXREFDES72# pcb schematic for constraints.
+*
+* PMOD_TYPE_I2C - 
+* Switches SWA7, SWA9, SWA12 and SWB8, SWB10, SWB11 closed.  All other
+* switches open
+*
+* PMOD_TYPE_1_GPIO - 
+* Switches all open, mux not used
+*
+* PMOD_TYPE_2_SPI - 
+* Switches all open, mux not used
+*
+* PMOD_TYPE_3_UART - 
+* Switches SWA2, SWA12 and SWB1, SWB11 closed.  All other switches open
+*
+* PMOD_TYPE_4_UART - 
+* Switches SWA1, SWA13 and SWB2, SWB12 closed.  All other switches open
+*
+* PMOD_TYPE_5_HBRIDGE - 
+* Switches all open, mux not used
+*
+* PMOD_TYPE_6_HBRIDGE - 
+* Switches all open, mux not used
+**********************************************************************/
+class Ard2Pmod : public Max14661, public Ds3231
+{
+    public:
+	    /**************************************************************//**
+	    * Constructor for Ard2Pmod Class
+	    *
+	    * On Entry:
+	    *     @param[in] pmod_type - desired PMOD interface
+	    *
+	    * On Exit:
+	    *    @return none
+	    *
+	    * Example:
+		* @code
+		* #include "ard2pmod.h"
+		*
+		* int main(void)
+		* {  
+		*     Ard2Pmod ard2pmod(PMOD_TYPE_1_GPIO);
+		*     
+		*     //main app.
+		*     for(;;)
+		*     {
+		*     }
+		* }
+		* @endcode
+		******************************************************************/
+		Ard2Pmod(pmod_type_t pmod_type); 
+
+};
+
+
+#endif /* ARD2PMOD_H*/
\ No newline at end of file