Juan Salazar / mbed

test

Dependents:   robotic_fish_7

BusIn.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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