PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/BusOut.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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