takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/BusIn.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?

UserRevisionLine numberNew 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_BUSIN_H
kadonotakashi 0:8fdf9a60065b 17 #define MBED_BUSIN_H
kadonotakashi 0:8fdf9a60065b 18
kadonotakashi 0:8fdf9a60065b 19 #include "platform/platform.h"
kadonotakashi 0:8fdf9a60065b 20 #include "drivers/DigitalIn.h"
kadonotakashi 0:8fdf9a60065b 21 #include "platform/PlatformMutex.h"
kadonotakashi 0:8fdf9a60065b 22 #include "platform/NonCopyable.h"
kadonotakashi 0:8fdf9a60065b 23
kadonotakashi 0:8fdf9a60065b 24 namespace mbed {
kadonotakashi 0:8fdf9a60065b 25 /** \addtogroup drivers */
kadonotakashi 0:8fdf9a60065b 26
kadonotakashi 0:8fdf9a60065b 27 /** A digital input bus, used for reading the state of a collection of pins
kadonotakashi 0:8fdf9a60065b 28 *
kadonotakashi 0:8fdf9a60065b 29 * @note Synchronization level: Thread safe
kadonotakashi 0:8fdf9a60065b 30 * @ingroup drivers
kadonotakashi 0:8fdf9a60065b 31 */
kadonotakashi 0:8fdf9a60065b 32 class BusIn : private NonCopyable<BusIn> {
kadonotakashi 0:8fdf9a60065b 33
kadonotakashi 0:8fdf9a60065b 34 public:
kadonotakashi 0:8fdf9a60065b 35 /* Group: Configuration Methods */
kadonotakashi 0:8fdf9a60065b 36
kadonotakashi 0:8fdf9a60065b 37 /** Create an BusIn, connected to the specified pins
kadonotakashi 0:8fdf9a60065b 38 *
kadonotakashi 0:8fdf9a60065b 39 * @param p0 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 40 * @param p1 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 41 * @param p2 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 42 * @param p3 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 43 * @param p4 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 44 * @param p5 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 45 * @param p6 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 46 * @param p7 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 47 * @param p8 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 48 * @param p9 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 49 * @param p10 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 50 * @param p11 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 51 * @param p12 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 52 * @param p13 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 53 * @param p14 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 54 * @param p15 DigitalIn pin to connect to bus bit
kadonotakashi 0:8fdf9a60065b 55 *
kadonotakashi 0:8fdf9a60065b 56 * @note
kadonotakashi 0:8fdf9a60065b 57 * It is only required to specify as many pin variables as is required
kadonotakashi 0:8fdf9a60065b 58 * for the bus; the rest will default to NC (not connected)
kadonotakashi 0:8fdf9a60065b 59 */
kadonotakashi 0:8fdf9a60065b 60 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
kadonotakashi 0:8fdf9a60065b 61 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
kadonotakashi 0:8fdf9a60065b 62 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
kadonotakashi 0:8fdf9a60065b 63 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
kadonotakashi 0:8fdf9a60065b 64
kadonotakashi 0:8fdf9a60065b 65
kadonotakashi 0:8fdf9a60065b 66 /** Create an BusIn, connected to the specified pins
kadonotakashi 0:8fdf9a60065b 67 *
kadonotakashi 0:8fdf9a60065b 68 * @param pins An array of pins to connect to bus bit
kadonotakashi 0:8fdf9a60065b 69 */
kadonotakashi 0:8fdf9a60065b 70 BusIn(PinName pins[16]);
kadonotakashi 0:8fdf9a60065b 71
kadonotakashi 0:8fdf9a60065b 72 virtual ~BusIn();
kadonotakashi 0:8fdf9a60065b 73
kadonotakashi 0:8fdf9a60065b 74 /** Read the value of the input bus
kadonotakashi 0:8fdf9a60065b 75 *
kadonotakashi 0:8fdf9a60065b 76 * @returns
kadonotakashi 0:8fdf9a60065b 77 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
kadonotakashi 0:8fdf9a60065b 78 */
kadonotakashi 0:8fdf9a60065b 79 int read();
kadonotakashi 0:8fdf9a60065b 80
kadonotakashi 0:8fdf9a60065b 81 /** Set the input pin mode
kadonotakashi 0:8fdf9a60065b 82 *
kadonotakashi 0:8fdf9a60065b 83 * @param pull PullUp, PullDown, PullNone
kadonotakashi 0:8fdf9a60065b 84 */
kadonotakashi 0:8fdf9a60065b 85 void mode(PinMode pull);
kadonotakashi 0:8fdf9a60065b 86
kadonotakashi 0:8fdf9a60065b 87 /** Binary mask of bus pins connected to actual pins (not NC pins)
kadonotakashi 0:8fdf9a60065b 88 * 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 89 *
kadonotakashi 0:8fdf9a60065b 90 * @returns
kadonotakashi 0:8fdf9a60065b 91 * Binary mask of connected pins
kadonotakashi 0:8fdf9a60065b 92 */
kadonotakashi 0:8fdf9a60065b 93 int mask()
kadonotakashi 0:8fdf9a60065b 94 {
kadonotakashi 0:8fdf9a60065b 95 // No lock needed since _nc_mask is not modified outside the constructor
kadonotakashi 0:8fdf9a60065b 96 return _nc_mask;
kadonotakashi 0:8fdf9a60065b 97 }
kadonotakashi 0:8fdf9a60065b 98
kadonotakashi 0:8fdf9a60065b 99 /** A shorthand for read()
kadonotakashi 0:8fdf9a60065b 100 * \sa DigitalIn::read()
kadonotakashi 0:8fdf9a60065b 101 */
kadonotakashi 0:8fdf9a60065b 102 operator int();
kadonotakashi 0:8fdf9a60065b 103
kadonotakashi 0:8fdf9a60065b 104 /** Access to particular bit in random-iterator fashion
kadonotakashi 0:8fdf9a60065b 105 * @param index Position of bit
kadonotakashi 0:8fdf9a60065b 106 */
kadonotakashi 0:8fdf9a60065b 107 DigitalIn &operator[](int index);
kadonotakashi 0:8fdf9a60065b 108
kadonotakashi 0:8fdf9a60065b 109 protected:
kadonotakashi 0:8fdf9a60065b 110 DigitalIn *_pin[16];
kadonotakashi 0:8fdf9a60065b 111
kadonotakashi 0:8fdf9a60065b 112 /* Mask of bus's NC pins
kadonotakashi 0:8fdf9a60065b 113 * If bit[n] is set to 1 - pin is connected
kadonotakashi 0:8fdf9a60065b 114 * if bit[n] is cleared - pin is not connected (NC)
kadonotakashi 0:8fdf9a60065b 115 */
kadonotakashi 0:8fdf9a60065b 116 int _nc_mask;
kadonotakashi 0:8fdf9a60065b 117
kadonotakashi 0:8fdf9a60065b 118 PlatformMutex _mutex;
kadonotakashi 0:8fdf9a60065b 119
kadonotakashi 0:8fdf9a60065b 120 private:
kadonotakashi 0:8fdf9a60065b 121 virtual void lock();
kadonotakashi 0:8fdf9a60065b 122 virtual void unlock();
kadonotakashi 0:8fdf9a60065b 123 };
kadonotakashi 0:8fdf9a60065b 124
kadonotakashi 0:8fdf9a60065b 125 } // namespace mbed
kadonotakashi 0:8fdf9a60065b 126
kadonotakashi 0:8fdf9a60065b 127 #endif
kadonotakashi 0:8fdf9a60065b 128