Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/BusOut.h@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
cpp/BusOut.h@2:143cac498751
Child:
10:3bc89ef62ce7
Refactoring of the mbed SDK:

- Provide a well defined HAL and API

- Keep separated the HAL implementations for the different targets

Who changed what in which revision?

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