Paul Paterson / mbed-src-CanNucleoF0

mbed library sources, include can_api for nucleo-f091rc

Dependents:   CanNucleoF0_example

Fork of mbed-src by mbed official

cpp/BusOut.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_BUSOUT_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_BUSOUT_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "DigitalOut.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 /** A digital output bus, used for setting the state of a collection of pins
mbed_official 0:fd0d7bdfcdc2 30 */
mbed_official 0:fd0d7bdfcdc2 31 class BusOut {
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 public:
mbed_official 0:fd0d7bdfcdc2 34
mbed_official 0:fd0d7bdfcdc2 35 /** Create an BusOut, connected to the specified pins
mbed_official 0:fd0d7bdfcdc2 36 *
mbed_official 0:fd0d7bdfcdc2 37 * @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * @note
mbed_official 0:fd0d7bdfcdc2 40 * It is only required to specify as many pin variables as is required
mbed_official 0:fd0d7bdfcdc2 41 * for the bus; the rest will default to NC (not connected)
mbed_official 0:fd0d7bdfcdc2 42 */
mbed_official 0:fd0d7bdfcdc2 43 BusOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
mbed_official 0:fd0d7bdfcdc2 44 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
mbed_official 0:fd0d7bdfcdc2 45 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
mbed_official 0:fd0d7bdfcdc2 46 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
mbed_official 0:fd0d7bdfcdc2 47
mbed_official 0:fd0d7bdfcdc2 48 BusOut(PinName pins[16]);
mbed_official 0:fd0d7bdfcdc2 49
mbed_official 0:fd0d7bdfcdc2 50 virtual ~BusOut();
mbed_official 0:fd0d7bdfcdc2 51
mbed_official 0:fd0d7bdfcdc2 52 /** Write the value to the output bus
mbed_official 0:fd0d7bdfcdc2 53 *
mbed_official 0:fd0d7bdfcdc2 54 * @param value An integer specifying a bit to write for every corresponding DigitalOut pin
mbed_official 0:fd0d7bdfcdc2 55 */
mbed_official 0:fd0d7bdfcdc2 56 void write(int value);
mbed_official 0:fd0d7bdfcdc2 57
mbed_official 0:fd0d7bdfcdc2 58 /** Read the value currently output on the bus
mbed_official 0:fd0d7bdfcdc2 59 *
mbed_official 0:fd0d7bdfcdc2 60 * @returns
mbed_official 0:fd0d7bdfcdc2 61 * An integer with each bit corresponding to associated DigitalOut pin setting
mbed_official 0:fd0d7bdfcdc2 62 */
mbed_official 0:fd0d7bdfcdc2 63 int read();
mbed_official 0:fd0d7bdfcdc2 64
mbed_official 0:fd0d7bdfcdc2 65 #ifdef MBED_OPERATORS
mbed_official 0:fd0d7bdfcdc2 66 /** A shorthand for write()
mbed_official 0:fd0d7bdfcdc2 67 */
mbed_official 0:fd0d7bdfcdc2 68 BusOut& operator= (int v);
mbed_official 0:fd0d7bdfcdc2 69 BusOut& operator= (BusOut& rhs);
mbed_official 0:fd0d7bdfcdc2 70
mbed_official 0:fd0d7bdfcdc2 71 /** A shorthand for read()
mbed_official 0:fd0d7bdfcdc2 72 */
mbed_official 0:fd0d7bdfcdc2 73 operator int();
mbed_official 0:fd0d7bdfcdc2 74 #endif
mbed_official 0:fd0d7bdfcdc2 75
mbed_official 0:fd0d7bdfcdc2 76 protected:
mbed_official 0:fd0d7bdfcdc2 77 DigitalOut* _pin[16];
mbed_official 0:fd0d7bdfcdc2 78 };
mbed_official 0:fd0d7bdfcdc2 79
mbed_official 0:fd0d7bdfcdc2 80 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 81
mbed_official 0:fd0d7bdfcdc2 82 #endif