Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/BusOut.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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