TUKS MCU Introductory course / TUKS-COURSE-TIMER

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/BusInOut.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

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