Juan Salazar / mbed

test

Dependents:   robotic_fish_7

BusOut.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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