Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

BusIn.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
93:e188a91d3eaa 
12

Who changed what in which revision?

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