Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/drivers/BusOut.h@11:b3f2a8bdac4d, 2017-12-16 (annotated)

Committer:
Zaitsev
Date:
Sat Dec 16 10:26:48 2017 +0000
Revision:
11:b3f2a8bdac4d
Parent:
10:41552d038a69 
A copy for D.S;

Who changed what in which revision?

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