Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/BusOut.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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