Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/BusInOut.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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