Aditya Mehrotra / mbed-dev

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.

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

drivers/BusInOut.h@3:993b4d6ff61e, 2021-03-09 (annotated)

Committer:
adimmit
Date:
Tue Mar 09 20:33:24 2021 +0000
Revision:
3:993b4d6ff61e
Parent:
0:083111ae2a11 
added CAN3

Who changed what in which revision?

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