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/BusIn.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_BUSIN_H
aravindsv 0:ba7650f404af 17 #define MBED_BUSIN_H
aravindsv 0:ba7650f404af 18
aravindsv 0:ba7650f404af 19 #include "platform.h"
aravindsv 0:ba7650f404af 20 #include "DigitalIn.h"
aravindsv 0:ba7650f404af 21
aravindsv 0:ba7650f404af 22 namespace mbed {
aravindsv 0:ba7650f404af 23
aravindsv 0:ba7650f404af 24 /** A digital input bus, used for reading the state of a collection of pins
aravindsv 0:ba7650f404af 25 */
aravindsv 0:ba7650f404af 26 class BusIn {
aravindsv 0:ba7650f404af 27
aravindsv 0:ba7650f404af 28 public:
aravindsv 0:ba7650f404af 29 /* Group: Configuration Methods */
aravindsv 0:ba7650f404af 30
aravindsv 0:ba7650f404af 31 /** Create an BusIn, connected to the specified pins
aravindsv 0:ba7650f404af 32 *
aravindsv 0:ba7650f404af 33 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
aravindsv 0:ba7650f404af 34 *
aravindsv 0:ba7650f404af 35 * @note
aravindsv 0:ba7650f404af 36 * It is only required to specify as many pin variables as is required
aravindsv 0:ba7650f404af 37 * for the bus; the rest will default to NC (not connected)
aravindsv 0:ba7650f404af 38 */
aravindsv 0:ba7650f404af 39 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
aravindsv 0:ba7650f404af 40 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
aravindsv 0:ba7650f404af 41 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
aravindsv 0:ba7650f404af 42 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
aravindsv 0:ba7650f404af 43
aravindsv 0:ba7650f404af 44 BusIn(PinName pins[16]);
aravindsv 0:ba7650f404af 45
aravindsv 0:ba7650f404af 46 virtual ~BusIn();
aravindsv 0:ba7650f404af 47
aravindsv 0:ba7650f404af 48 /** Read the value of the input bus
aravindsv 0:ba7650f404af 49 *
aravindsv 0:ba7650f404af 50 * @returns
aravindsv 0:ba7650f404af 51 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
aravindsv 0:ba7650f404af 52 */
aravindsv 0:ba7650f404af 53 int read();
aravindsv 0:ba7650f404af 54
aravindsv 0:ba7650f404af 55 /** Set the input pin mode
aravindsv 0:ba7650f404af 56 *
aravindsv 0:ba7650f404af 57 * @param mode PullUp, PullDown, PullNone
aravindsv 0:ba7650f404af 58 */
aravindsv 0:ba7650f404af 59 void mode(PinMode pull);
aravindsv 0:ba7650f404af 60
aravindsv 0:ba7650f404af 61 /** Binary mask of bus pins connected to actual pins (not NC pins)
aravindsv 0:ba7650f404af 62 * 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 63 *
aravindsv 0:ba7650f404af 64 * @returns
aravindsv 0:ba7650f404af 65 * Binary mask of connected pins
aravindsv 0:ba7650f404af 66 */
aravindsv 0:ba7650f404af 67 int mask() {
aravindsv 0:ba7650f404af 68 return _nc_mask;
aravindsv 0:ba7650f404af 69 }
aravindsv 0:ba7650f404af 70
aravindsv 0:ba7650f404af 71 #ifdef MBED_OPERATORS
aravindsv 0:ba7650f404af 72 /** A shorthand for read()
aravindsv 0:ba7650f404af 73 */
aravindsv 0:ba7650f404af 74 operator int();
aravindsv 0:ba7650f404af 75
aravindsv 0:ba7650f404af 76 /** Access to particular bit in random-iterator fashion
aravindsv 0:ba7650f404af 77 */
aravindsv 0:ba7650f404af 78 DigitalIn & operator[] (int index);
aravindsv 0:ba7650f404af 79 #endif
aravindsv 0:ba7650f404af 80
aravindsv 0:ba7650f404af 81 protected:
aravindsv 0:ba7650f404af 82 DigitalIn* _pin[16];
aravindsv 0:ba7650f404af 83
aravindsv 0:ba7650f404af 84 /** Mask of bus's NC pins
aravindsv 0:ba7650f404af 85 * If bit[n] is set to 1 - pin is connected
aravindsv 0:ba7650f404af 86 * if bit[n] is cleared - pin is not connected (NC)
aravindsv 0:ba7650f404af 87 */
aravindsv 0:ba7650f404af 88 int _nc_mask;
aravindsv 0:ba7650f404af 89
aravindsv 0:ba7650f404af 90 /* disallow copy constructor and assignment operators */
aravindsv 0:ba7650f404af 91 private:
aravindsv 0:ba7650f404af 92 BusIn(const BusIn&);
aravindsv 0:ba7650f404af 93 BusIn & operator = (const BusIn&);
aravindsv 0:ba7650f404af 94 };
aravindsv 0:ba7650f404af 95
aravindsv 0:ba7650f404af 96 } // namespace mbed
aravindsv 0:ba7650f404af 97
aravindsv 0:ba7650f404af 98 #endif