cc y / mbed

ads1115 only

Fork of mbed by mbed official

BusInOut.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
rolf.meyer@arm.com 11:1c1ebd0324fa 21 */
rolf.meyer@arm.com 11:1c1ebd0324fa 22 #ifndef MBED_BUSINOUT_H
rolf.meyer@arm.com 11:1c1ebd0324fa 23 #define MBED_BUSINOUT_H
rolf.meyer@arm.com 11:1c1ebd0324fa 24
rolf.meyer@arm.com 11:1c1ebd0324fa 25 #include "DigitalInOut.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 26
rolf.meyer@arm.com 11:1c1ebd0324fa 27 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 28
emilmont 43:e2ed12d17f06 29 /** A digital input output bus, used for setting the state of a collection of pins
rolf.meyer@arm.com 11:1c1ebd0324fa 30 */
emilmont 44:24d45a770a51 31 class BusInOut {
rolf.meyer@arm.com 11:1c1ebd0324fa 32
rolf.meyer@arm.com 11:1c1ebd0324fa 33 public:
emilmont 44:24d45a770a51 34
emilmont 43:e2ed12d17f06 35 /** Create an BusInOut, connected to the specified pins
emilmont 43:e2ed12d17f06 36 *
emilmont 43:e2ed12d17f06 37 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
rolf.meyer@arm.com 11:1c1ebd0324fa 38 *
emilmont 43:e2ed12d17f06 39 * @note
emilmont 44:24d45a770a51 40 * It is only required to specify as many pin variables as is required
emilmont 44:24d45a770a51 41 * for the bus; the rest will default to NC (not connected)
emilmont 44:24d45a770a51 42 */
rolf.meyer@arm.com 11:1c1ebd0324fa 43 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 44 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 45 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
emilmont 44:24d45a770a51 46 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
rolf.meyer@arm.com 11:1c1ebd0324fa 47
emilmont 44:24d45a770a51 48 BusInOut(PinName pins[16]);
rolf.meyer@arm.com 11:1c1ebd0324fa 49
rolf.meyer@arm.com 11:1c1ebd0324fa 50 virtual ~BusInOut();
rolf.meyer@arm.com 11:1c1ebd0324fa 51
rolf.meyer@arm.com 11:1c1ebd0324fa 52 /* Group: Access Methods */
emilmont 44:24d45a770a51 53
emilmont 43:e2ed12d17f06 54 /** Write the value to the output bus
rolf.meyer@arm.com 11:1c1ebd0324fa 55 *
emilmont 43:e2ed12d17f06 56 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
rolf.meyer@arm.com 11:1c1ebd0324fa 57 */
rolf.meyer@arm.com 11:1c1ebd0324fa 58 void write(int value);
rolf.meyer@arm.com 11:1c1ebd0324fa 59
emilmont 43:e2ed12d17f06 60
emilmont 43:e2ed12d17f06 61 /** Read the value currently output on the bus
rolf.meyer@arm.com 11:1c1ebd0324fa 62 *
emilmont 43:e2ed12d17f06 63 * @returns
emilmont 43:e2ed12d17f06 64 * An integer with each bit corresponding to associated DigitalInOut pin setting
rolf.meyer@arm.com 11:1c1ebd0324fa 65 */
rolf.meyer@arm.com 11:1c1ebd0324fa 66 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 67
emilmont 43:e2ed12d17f06 68 /** Set as an output
rolf.meyer@arm.com 11:1c1ebd0324fa 69 */
rolf.meyer@arm.com 11:1c1ebd0324fa 70 void output();
rolf.meyer@arm.com 11:1c1ebd0324fa 71
emilmont 43:e2ed12d17f06 72 /** Set as an input
rolf.meyer@arm.com 11:1c1ebd0324fa 73 */
rolf.meyer@arm.com 11:1c1ebd0324fa 74 void input();
rolf.meyer@arm.com 11:1c1ebd0324fa 75
emilmont 43:e2ed12d17f06 76 /** Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 77 *
emilmont 43:e2ed12d17f06 78 * @param mode PullUp, PullDown, PullNone
rolf.meyer@arm.com 11:1c1ebd0324fa 79 */
rolf.meyer@arm.com 11:1c1ebd0324fa 80 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 81
rolf.meyer@arm.com 11:1c1ebd0324fa 82 #ifdef MBED_OPERATORS
emilmont 43:e2ed12d17f06 83 /** A shorthand for write()
rolf.meyer@arm.com 11:1c1ebd0324fa 84 */
rolf.meyer@arm.com 11:1c1ebd0324fa 85 BusInOut& operator= (int v);
rolf.meyer@arm.com 11:1c1ebd0324fa 86 BusInOut& operator= (BusInOut& rhs);
rolf.meyer@arm.com 11:1c1ebd0324fa 87
emilmont 43:e2ed12d17f06 88 /** A shorthand for read()
rolf.meyer@arm.com 11:1c1ebd0324fa 89 */
rolf.meyer@arm.com 11:1c1ebd0324fa 90 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 91 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 92
rolf.meyer@arm.com 11:1c1ebd0324fa 93 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 94 DigitalInOut* _pin[16];
rolf.meyer@arm.com 11:1c1ebd0324fa 95 };
rolf.meyer@arm.com 11:1c1ebd0324fa 96
rolf.meyer@arm.com 11:1c1ebd0324fa 97 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 98
rolf.meyer@arm.com 11:1c1ebd0324fa 99 #endif