takashi kadono
/
Nucleo_446
Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466
mbed-os/drivers/BusInOut.h@0:8fdf9a60065b, 2018-10-10 (annotated)
- Committer:
- kadonotakashi
- Date:
- Wed Oct 10 00:33:53 2018 +0000
- Revision:
- 0:8fdf9a60065b
how to make mbed librry
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kadonotakashi | 0:8fdf9a60065b | 1 | /* mbed Microcontroller Library |
kadonotakashi | 0:8fdf9a60065b | 2 | * Copyright (c) 2006-2013 ARM Limited |
kadonotakashi | 0:8fdf9a60065b | 3 | * |
kadonotakashi | 0:8fdf9a60065b | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kadonotakashi | 0:8fdf9a60065b | 5 | * you may not use this file except in compliance with the License. |
kadonotakashi | 0:8fdf9a60065b | 6 | * You may obtain a copy of the License at |
kadonotakashi | 0:8fdf9a60065b | 7 | * |
kadonotakashi | 0:8fdf9a60065b | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
kadonotakashi | 0:8fdf9a60065b | 9 | * |
kadonotakashi | 0:8fdf9a60065b | 10 | * Unless required by applicable law or agreed to in writing, software |
kadonotakashi | 0:8fdf9a60065b | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
kadonotakashi | 0:8fdf9a60065b | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kadonotakashi | 0:8fdf9a60065b | 13 | * See the License for the specific language governing permissions and |
kadonotakashi | 0:8fdf9a60065b | 14 | * limitations under the License. |
kadonotakashi | 0:8fdf9a60065b | 15 | */ |
kadonotakashi | 0:8fdf9a60065b | 16 | #ifndef MBED_BUSINOUT_H |
kadonotakashi | 0:8fdf9a60065b | 17 | #define MBED_BUSINOUT_H |
kadonotakashi | 0:8fdf9a60065b | 18 | |
kadonotakashi | 0:8fdf9a60065b | 19 | #include "drivers/DigitalInOut.h" |
kadonotakashi | 0:8fdf9a60065b | 20 | #include "platform/PlatformMutex.h" |
kadonotakashi | 0:8fdf9a60065b | 21 | #include "platform/NonCopyable.h" |
kadonotakashi | 0:8fdf9a60065b | 22 | |
kadonotakashi | 0:8fdf9a60065b | 23 | namespace mbed { |
kadonotakashi | 0:8fdf9a60065b | 24 | /** \addtogroup drivers */ |
kadonotakashi | 0:8fdf9a60065b | 25 | |
kadonotakashi | 0:8fdf9a60065b | 26 | /** A digital input output bus, used for setting the state of a collection of pins |
kadonotakashi | 0:8fdf9a60065b | 27 | * |
kadonotakashi | 0:8fdf9a60065b | 28 | * @note Synchronization level: Thread safe |
kadonotakashi | 0:8fdf9a60065b | 29 | * @ingroup drivers |
kadonotakashi | 0:8fdf9a60065b | 30 | */ |
kadonotakashi | 0:8fdf9a60065b | 31 | class BusInOut : private NonCopyable<BusInOut> { |
kadonotakashi | 0:8fdf9a60065b | 32 | |
kadonotakashi | 0:8fdf9a60065b | 33 | public: |
kadonotakashi | 0:8fdf9a60065b | 34 | |
kadonotakashi | 0:8fdf9a60065b | 35 | /** Create an BusInOut, connected to the specified pins |
kadonotakashi | 0:8fdf9a60065b | 36 | * |
kadonotakashi | 0:8fdf9a60065b | 37 | * @param p0 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 38 | * @param p1 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 39 | * @param p2 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 40 | * @param p3 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 41 | * @param p4 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 42 | * @param p5 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 43 | * @param p6 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 44 | * @param p7 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 45 | * @param p8 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 46 | * @param p9 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 47 | * @param p10 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 48 | * @param p11 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 49 | * @param p12 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 50 | * @param p13 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 51 | * @param p14 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 52 | * @param p15 DigitalInOut pin to connect to bus bit |
kadonotakashi | 0:8fdf9a60065b | 53 | * |
kadonotakashi | 0:8fdf9a60065b | 54 | * @note |
kadonotakashi | 0:8fdf9a60065b | 55 | * It is only required to specify as many pin variables as is required |
kadonotakashi | 0:8fdf9a60065b | 56 | * for the bus; the rest will default to NC (not connected) |
kadonotakashi | 0:8fdf9a60065b | 57 | */ |
kadonotakashi | 0:8fdf9a60065b | 58 | BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC, |
kadonotakashi | 0:8fdf9a60065b | 59 | PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC, |
kadonotakashi | 0:8fdf9a60065b | 60 | PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC, |
kadonotakashi | 0:8fdf9a60065b | 61 | PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC); |
kadonotakashi | 0:8fdf9a60065b | 62 | |
kadonotakashi | 0:8fdf9a60065b | 63 | /** Create an BusInOut, connected to the specified pins |
kadonotakashi | 0:8fdf9a60065b | 64 | * |
kadonotakashi | 0:8fdf9a60065b | 65 | * @param pins An array of pins to construct a BusInOut from |
kadonotakashi | 0:8fdf9a60065b | 66 | */ |
kadonotakashi | 0:8fdf9a60065b | 67 | BusInOut(PinName pins[16]); |
kadonotakashi | 0:8fdf9a60065b | 68 | |
kadonotakashi | 0:8fdf9a60065b | 69 | virtual ~BusInOut(); |
kadonotakashi | 0:8fdf9a60065b | 70 | |
kadonotakashi | 0:8fdf9a60065b | 71 | /* Group: Access Methods */ |
kadonotakashi | 0:8fdf9a60065b | 72 | |
kadonotakashi | 0:8fdf9a60065b | 73 | /** Write the value to the output bus |
kadonotakashi | 0:8fdf9a60065b | 74 | * |
kadonotakashi | 0:8fdf9a60065b | 75 | * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin |
kadonotakashi | 0:8fdf9a60065b | 76 | */ |
kadonotakashi | 0:8fdf9a60065b | 77 | void write(int value); |
kadonotakashi | 0:8fdf9a60065b | 78 | |
kadonotakashi | 0:8fdf9a60065b | 79 | /** Read the value currently output on the bus |
kadonotakashi | 0:8fdf9a60065b | 80 | * |
kadonotakashi | 0:8fdf9a60065b | 81 | * @returns |
kadonotakashi | 0:8fdf9a60065b | 82 | * An integer with each bit corresponding to associated DigitalInOut pin setting |
kadonotakashi | 0:8fdf9a60065b | 83 | */ |
kadonotakashi | 0:8fdf9a60065b | 84 | int read(); |
kadonotakashi | 0:8fdf9a60065b | 85 | |
kadonotakashi | 0:8fdf9a60065b | 86 | /** Set as an output |
kadonotakashi | 0:8fdf9a60065b | 87 | */ |
kadonotakashi | 0:8fdf9a60065b | 88 | void output(); |
kadonotakashi | 0:8fdf9a60065b | 89 | |
kadonotakashi | 0:8fdf9a60065b | 90 | /** Set as an input |
kadonotakashi | 0:8fdf9a60065b | 91 | */ |
kadonotakashi | 0:8fdf9a60065b | 92 | void input(); |
kadonotakashi | 0:8fdf9a60065b | 93 | |
kadonotakashi | 0:8fdf9a60065b | 94 | /** Set the input pin mode |
kadonotakashi | 0:8fdf9a60065b | 95 | * |
kadonotakashi | 0:8fdf9a60065b | 96 | * @param pull PullUp, PullDown, PullNone |
kadonotakashi | 0:8fdf9a60065b | 97 | */ |
kadonotakashi | 0:8fdf9a60065b | 98 | void mode(PinMode pull); |
kadonotakashi | 0:8fdf9a60065b | 99 | |
kadonotakashi | 0:8fdf9a60065b | 100 | /** Binary mask of bus pins connected to actual pins (not NC pins) |
kadonotakashi | 0:8fdf9a60065b | 101 | * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1 |
kadonotakashi | 0:8fdf9a60065b | 102 | * |
kadonotakashi | 0:8fdf9a60065b | 103 | * @returns |
kadonotakashi | 0:8fdf9a60065b | 104 | * Binary mask of connected pins |
kadonotakashi | 0:8fdf9a60065b | 105 | */ |
kadonotakashi | 0:8fdf9a60065b | 106 | int mask() |
kadonotakashi | 0:8fdf9a60065b | 107 | { |
kadonotakashi | 0:8fdf9a60065b | 108 | // No lock needed since _nc_mask is not modified outside the constructor |
kadonotakashi | 0:8fdf9a60065b | 109 | return _nc_mask; |
kadonotakashi | 0:8fdf9a60065b | 110 | } |
kadonotakashi | 0:8fdf9a60065b | 111 | |
kadonotakashi | 0:8fdf9a60065b | 112 | /** A shorthand for write() |
kadonotakashi | 0:8fdf9a60065b | 113 | * \sa BusInOut::write() |
kadonotakashi | 0:8fdf9a60065b | 114 | */ |
kadonotakashi | 0:8fdf9a60065b | 115 | BusInOut &operator= (int v); |
kadonotakashi | 0:8fdf9a60065b | 116 | BusInOut &operator= (BusInOut &rhs); |
kadonotakashi | 0:8fdf9a60065b | 117 | |
kadonotakashi | 0:8fdf9a60065b | 118 | /** Access to particular bit in random-iterator fashion |
kadonotakashi | 0:8fdf9a60065b | 119 | * @param index Bit Position |
kadonotakashi | 0:8fdf9a60065b | 120 | */ |
kadonotakashi | 0:8fdf9a60065b | 121 | DigitalInOut &operator[](int index); |
kadonotakashi | 0:8fdf9a60065b | 122 | |
kadonotakashi | 0:8fdf9a60065b | 123 | /** A shorthand for read() |
kadonotakashi | 0:8fdf9a60065b | 124 | * \sa BusInOut::read() |
kadonotakashi | 0:8fdf9a60065b | 125 | */ |
kadonotakashi | 0:8fdf9a60065b | 126 | operator int(); |
kadonotakashi | 0:8fdf9a60065b | 127 | |
kadonotakashi | 0:8fdf9a60065b | 128 | protected: |
kadonotakashi | 0:8fdf9a60065b | 129 | virtual void lock(); |
kadonotakashi | 0:8fdf9a60065b | 130 | virtual void unlock(); |
kadonotakashi | 0:8fdf9a60065b | 131 | DigitalInOut *_pin[16]; |
kadonotakashi | 0:8fdf9a60065b | 132 | |
kadonotakashi | 0:8fdf9a60065b | 133 | /* Mask of bus's NC pins |
kadonotakashi | 0:8fdf9a60065b | 134 | * If bit[n] is set to 1 - pin is connected |
kadonotakashi | 0:8fdf9a60065b | 135 | * if bit[n] is cleared - pin is not connected (NC) |
kadonotakashi | 0:8fdf9a60065b | 136 | */ |
kadonotakashi | 0:8fdf9a60065b | 137 | int _nc_mask; |
kadonotakashi | 0:8fdf9a60065b | 138 | |
kadonotakashi | 0:8fdf9a60065b | 139 | PlatformMutex _mutex; |
kadonotakashi | 0:8fdf9a60065b | 140 | }; |
kadonotakashi | 0:8fdf9a60065b | 141 | |
kadonotakashi | 0:8fdf9a60065b | 142 | } // namespace mbed |
kadonotakashi | 0:8fdf9a60065b | 143 | |
kadonotakashi | 0:8fdf9a60065b | 144 | #endif |