TUKS MCU Introductory course / TUKS-COURSE-2-LED

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/drivers/BusIn.h@6:0018763974d3, 2017-02-25 (annotated)

Committer:
elmot
Date:
Sat Feb 25 08:59:21 2017 +0000
Revision:
6:0018763974d3
Parent:
1:d0dfbce63a89 
No comment

Who changed what in which revision?

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