Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/BusInOut.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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