Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/BusInOut.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yihui 0:700cadd8b708 1 /* mbed Microcontroller Library
yihui 0:700cadd8b708 2 * Copyright (c) 2006-2013 ARM Limited
yihui 0:700cadd8b708 3 *
yihui 0:700cadd8b708 4 * Licensed under the Apache License, Version 2.0 (the "License");
yihui 0:700cadd8b708 5 * you may not use this file except in compliance with the License.
yihui 0:700cadd8b708 6 * You may obtain a copy of the License at
yihui 0:700cadd8b708 7 *
yihui 0:700cadd8b708 8 * http://www.apache.org/licenses/LICENSE-2.0
yihui 0:700cadd8b708 9 *
yihui 0:700cadd8b708 10 * Unless required by applicable law or agreed to in writing, software
yihui 0:700cadd8b708 11 * distributed under the License is distributed on an "AS IS" BASIS,
yihui 0:700cadd8b708 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
yihui 0:700cadd8b708 13 * See the License for the specific language governing permissions and
yihui 0:700cadd8b708 14 * limitations under the License.
yihui 0:700cadd8b708 15 */
yihui 0:700cadd8b708 16 #ifndef MBED_BUSINOUT_H
yihui 0:700cadd8b708 17 #define MBED_BUSINOUT_H
yihui 0:700cadd8b708 18
yihui 0:700cadd8b708 19 #include "DigitalInOut.h"
yihui 0:700cadd8b708 20
yihui 0:700cadd8b708 21 namespace mbed {
yihui 0:700cadd8b708 22
yihui 0:700cadd8b708 23 /** A digital input output bus, used for setting the state of a collection of pins
yihui 0:700cadd8b708 24 */
yihui 0:700cadd8b708 25 class BusInOut {
yihui 0:700cadd8b708 26
yihui 0:700cadd8b708 27 public:
yihui 0:700cadd8b708 28
yihui 0:700cadd8b708 29 /** Create an BusInOut, connected to the specified pins
yihui 0:700cadd8b708 30 *
yihui 0:700cadd8b708 31 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
yihui 0:700cadd8b708 32 *
yihui 0:700cadd8b708 33 * @note
yihui 0:700cadd8b708 34 * It is only required to specify as many pin variables as is required
yihui 0:700cadd8b708 35 * for the bus; the rest will default to NC (not connected)
yihui 0:700cadd8b708 36 */
yihui 0:700cadd8b708 37 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
yihui 0:700cadd8b708 38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
yihui 0:700cadd8b708 39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
yihui 0:700cadd8b708 40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
yihui 0:700cadd8b708 41
yihui 0:700cadd8b708 42 BusInOut(PinName pins[16]);
yihui 0:700cadd8b708 43
yihui 0:700cadd8b708 44 virtual ~BusInOut();
yihui 0:700cadd8b708 45
yihui 0:700cadd8b708 46 /* Group: Access Methods */
yihui 0:700cadd8b708 47
yihui 0:700cadd8b708 48 /** Write the value to the output bus
yihui 0:700cadd8b708 49 *
yihui 0:700cadd8b708 50 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
yihui 0:700cadd8b708 51 */
yihui 0:700cadd8b708 52 void write(int value);
yihui 0:700cadd8b708 53
yihui 0:700cadd8b708 54
yihui 0:700cadd8b708 55 /** Read the value currently output on the bus
yihui 0:700cadd8b708 56 *
yihui 0:700cadd8b708 57 * @returns
yihui 0:700cadd8b708 58 * An integer with each bit corresponding to associated DigitalInOut pin setting
yihui 0:700cadd8b708 59 */
yihui 0:700cadd8b708 60 int read();
yihui 0:700cadd8b708 61
yihui 0:700cadd8b708 62 /** Set as an output
yihui 0:700cadd8b708 63 */
yihui 0:700cadd8b708 64 void output();
yihui 0:700cadd8b708 65
yihui 0:700cadd8b708 66 /** Set as an input
yihui 0:700cadd8b708 67 */
yihui 0:700cadd8b708 68 void input();
yihui 0:700cadd8b708 69
yihui 0:700cadd8b708 70 /** Set the input pin mode
yihui 0:700cadd8b708 71 *
yihui 0:700cadd8b708 72 * @param mode PullUp, PullDown, PullNone
yihui 0:700cadd8b708 73 */
yihui 0:700cadd8b708 74 void mode(PinMode pull);
yihui 0:700cadd8b708 75
yihui 0:700cadd8b708 76 #ifdef MBED_OPERATORS
yihui 0:700cadd8b708 77 /** A shorthand for write()
yihui 0:700cadd8b708 78 */
yihui 0:700cadd8b708 79 BusInOut& operator= (int v);
yihui 0:700cadd8b708 80 BusInOut& operator= (BusInOut& rhs);
yihui 0:700cadd8b708 81
yihui 0:700cadd8b708 82 /** A shorthand for read()
yihui 0:700cadd8b708 83 */
yihui 0:700cadd8b708 84 operator int();
yihui 0:700cadd8b708 85 #endif
yihui 0:700cadd8b708 86
yihui 0:700cadd8b708 87 protected:
yihui 0:700cadd8b708 88 DigitalInOut* _pin[16];
yihui 0:700cadd8b708 89
yihui 0:700cadd8b708 90 /* disallow copy constructor and assignment operators */
yihui 0:700cadd8b708 91 private:
yihui 0:700cadd8b708 92 BusInOut(const BusInOut&);
yihui 0:700cadd8b708 93 BusInOut & operator = (const BusInOut&);
yihui 0:700cadd8b708 94 };
yihui 0:700cadd8b708 95
yihui 0:700cadd8b708 96 } // namespace mbed
yihui 0:700cadd8b708 97
yihui 0:700cadd8b708 98 #endif