Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

BusInOut.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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