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/BusInOut.h@2:798925c9e4a8, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:55:34 2018 +0000
Revision:
2:798925c9e4a8
Parent:
1:9c5af431a1f1 
bluetooth

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_BUSINOUT_H
gustavatmel 1:9c5af431a1f1 17 #define MBED_BUSINOUT_H
gustavatmel 1:9c5af431a1f1 18
gustavatmel 1:9c5af431a1f1 19 #include "drivers/DigitalInOut.h"
gustavatmel 1:9c5af431a1f1 20 #include "platform/PlatformMutex.h"
gustavatmel 1:9c5af431a1f1 21 #include "platform/NonCopyable.h"
gustavatmel 1:9c5af431a1f1 22
gustavatmel 1:9c5af431a1f1 23 namespace mbed {
gustavatmel 1:9c5af431a1f1 24 /** \addtogroup drivers */
gustavatmel 1:9c5af431a1f1 25
gustavatmel 1:9c5af431a1f1 26 /** A digital input output bus, used for setting the state of a collection of pins
gustavatmel 1:9c5af431a1f1 27 *
gustavatmel 1:9c5af431a1f1 28 * @note Synchronization level: Thread safe
gustavatmel 1:9c5af431a1f1 29 * @ingroup drivers
gustavatmel 1:9c5af431a1f1 30 */
gustavatmel 1:9c5af431a1f1 31 class BusInOut : private NonCopyable<BusInOut> {
gustavatmel 1:9c5af431a1f1 32
gustavatmel 1:9c5af431a1f1 33 public:
gustavatmel 1:9c5af431a1f1 34
gustavatmel 1:9c5af431a1f1 35 /** Create an BusInOut, connected to the specified pins
gustavatmel 1:9c5af431a1f1 36 *
gustavatmel 1:9c5af431a1f1 37 * @param p0 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 38 * @param p1 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 39 * @param p2 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 40 * @param p3 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 41 * @param p4 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 42 * @param p5 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 43 * @param p6 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 44 * @param p7 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 45 * @param p8 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 46 * @param p9 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 47 * @param p10 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 48 * @param p11 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 49 * @param p12 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 50 * @param p13 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 51 * @param p14 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 52 * @param p15 DigitalInOut pin to connect to bus bit
gustavatmel 1:9c5af431a1f1 53 *
gustavatmel 1:9c5af431a1f1 54 * @note
gustavatmel 1:9c5af431a1f1 55 * It is only required to specify as many pin variables as is required
gustavatmel 1:9c5af431a1f1 56 * for the bus; the rest will default to NC (not connected)
gustavatmel 1:9c5af431a1f1 57 */
gustavatmel 1:9c5af431a1f1 58 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
gustavatmel 1:9c5af431a1f1 59 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
gustavatmel 1:9c5af431a1f1 60 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
gustavatmel 1:9c5af431a1f1 61 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
gustavatmel 1:9c5af431a1f1 62
gustavatmel 1:9c5af431a1f1 63 /** Create an BusInOut, connected to the specified pins
gustavatmel 1:9c5af431a1f1 64 *
gustavatmel 1:9c5af431a1f1 65 * @param pins An array of pins to construct a BusInOut from
gustavatmel 1:9c5af431a1f1 66 */
gustavatmel 1:9c5af431a1f1 67 BusInOut(PinName pins[16]);
gustavatmel 1:9c5af431a1f1 68
gustavatmel 1:9c5af431a1f1 69 virtual ~BusInOut();
gustavatmel 1:9c5af431a1f1 70
gustavatmel 1:9c5af431a1f1 71 /* Group: Access Methods */
gustavatmel 1:9c5af431a1f1 72
gustavatmel 1:9c5af431a1f1 73 /** Write the value to the output bus
gustavatmel 1:9c5af431a1f1 74 *
gustavatmel 1:9c5af431a1f1 75 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
gustavatmel 1:9c5af431a1f1 76 */
gustavatmel 1:9c5af431a1f1 77 void write(int value);
gustavatmel 1:9c5af431a1f1 78
gustavatmel 1:9c5af431a1f1 79 /** Read the value currently output on the bus
gustavatmel 1:9c5af431a1f1 80 *
gustavatmel 1:9c5af431a1f1 81 * @returns
gustavatmel 1:9c5af431a1f1 82 * An integer with each bit corresponding to associated DigitalInOut pin setting
gustavatmel 1:9c5af431a1f1 83 */
gustavatmel 1:9c5af431a1f1 84 int read();
gustavatmel 1:9c5af431a1f1 85
gustavatmel 1:9c5af431a1f1 86 /** Set as an output
gustavatmel 1:9c5af431a1f1 87 */
gustavatmel 1:9c5af431a1f1 88 void output();
gustavatmel 1:9c5af431a1f1 89
gustavatmel 1:9c5af431a1f1 90 /** Set as an input
gustavatmel 1:9c5af431a1f1 91 */
gustavatmel 1:9c5af431a1f1 92 void input();
gustavatmel 1:9c5af431a1f1 93
gustavatmel 1:9c5af431a1f1 94 /** Set the input pin mode
gustavatmel 1:9c5af431a1f1 95 *
gustavatmel 1:9c5af431a1f1 96 * @param pull PullUp, PullDown, PullNone
gustavatmel 1:9c5af431a1f1 97 */
gustavatmel 1:9c5af431a1f1 98 void mode(PinMode pull);
gustavatmel 1:9c5af431a1f1 99
gustavatmel 1:9c5af431a1f1 100 /** Binary mask of bus pins connected to actual pins (not NC pins)
gustavatmel 1:9c5af431a1f1 101 * 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 102 *
gustavatmel 1:9c5af431a1f1 103 * @returns
gustavatmel 1:9c5af431a1f1 104 * Binary mask of connected pins
gustavatmel 1:9c5af431a1f1 105 */
gustavatmel 1:9c5af431a1f1 106 int mask() {
gustavatmel 1:9c5af431a1f1 107 // No lock needed since _nc_mask is not modified outside the constructor
gustavatmel 1:9c5af431a1f1 108 return _nc_mask;
gustavatmel 1:9c5af431a1f1 109 }
gustavatmel 1:9c5af431a1f1 110
gustavatmel 1:9c5af431a1f1 111 /** A shorthand for write()
gustavatmel 1:9c5af431a1f1 112 * \sa BusInOut::write()
gustavatmel 1:9c5af431a1f1 113 */
gustavatmel 1:9c5af431a1f1 114 BusInOut& operator= (int v);
gustavatmel 1:9c5af431a1f1 115 BusInOut& operator= (BusInOut& rhs);
gustavatmel 1:9c5af431a1f1 116
gustavatmel 1:9c5af431a1f1 117 /** Access to particular bit in random-iterator fashion
gustavatmel 1:9c5af431a1f1 118 * @param index Bit Position
gustavatmel 1:9c5af431a1f1 119 */
gustavatmel 1:9c5af431a1f1 120 DigitalInOut& operator[] (int index);
gustavatmel 1:9c5af431a1f1 121
gustavatmel 1:9c5af431a1f1 122 /** A shorthand for read()
gustavatmel 1:9c5af431a1f1 123 * \sa BusInOut::read()
gustavatmel 1:9c5af431a1f1 124 */
gustavatmel 1:9c5af431a1f1 125 operator int();
gustavatmel 1:9c5af431a1f1 126
gustavatmel 1:9c5af431a1f1 127 protected:
gustavatmel 1:9c5af431a1f1 128 virtual void lock();
gustavatmel 1:9c5af431a1f1 129 virtual void unlock();
gustavatmel 1:9c5af431a1f1 130 DigitalInOut* _pin[16];
gustavatmel 1:9c5af431a1f1 131
gustavatmel 1:9c5af431a1f1 132 /* Mask of bus's NC pins
gustavatmel 1:9c5af431a1f1 133 * If bit[n] is set to 1 - pin is connected
gustavatmel 1:9c5af431a1f1 134 * if bit[n] is cleared - pin is not connected (NC)
gustavatmel 1:9c5af431a1f1 135 */
gustavatmel 1:9c5af431a1f1 136 int _nc_mask;
gustavatmel 1:9c5af431a1f1 137
gustavatmel 1:9c5af431a1f1 138 PlatformMutex _mutex;
gustavatmel 1:9c5af431a1f1 139 };
gustavatmel 1:9c5af431a1f1 140
gustavatmel 1:9c5af431a1f1 141 } // namespace mbed
gustavatmel 1:9c5af431a1f1 142
gustavatmel 1:9c5af431a1f1 143 #endif