BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

mbed-os/drivers/BusIn.h@1:9c5af431a1f1, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:47:08 2018 +0000
Revision:
1:9c5af431a1f1
sdf

Who changed what in which revision?

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