takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/PortIn.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_PORTIN_H
kadonotakashi 0:8fdf9a60065b 17 #define MBED_PORTIN_H
kadonotakashi 0:8fdf9a60065b 18
kadonotakashi 0:8fdf9a60065b 19 #include "platform/platform.h"
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 #if defined (DEVICE_PORTIN) || defined(DOXYGEN_ONLY)
kadonotakashi 0:8fdf9a60065b 22
kadonotakashi 0:8fdf9a60065b 23 #include "hal/port_api.h"
kadonotakashi 0:8fdf9a60065b 24 #include "platform/mbed_critical.h"
kadonotakashi 0:8fdf9a60065b 25
kadonotakashi 0:8fdf9a60065b 26 namespace mbed {
kadonotakashi 0:8fdf9a60065b 27 /** \addtogroup drivers */
kadonotakashi 0:8fdf9a60065b 28
kadonotakashi 0:8fdf9a60065b 29 /** A multiple pin digital input
kadonotakashi 0:8fdf9a60065b 30 *
kadonotakashi 0:8fdf9a60065b 31 * @note Synchronization level: Interrupt safe
kadonotakashi 0:8fdf9a60065b 32 *
kadonotakashi 0:8fdf9a60065b 33 * Example:
kadonotakashi 0:8fdf9a60065b 34 * @code
kadonotakashi 0:8fdf9a60065b 35 * // Switch on an LED if any of mbed pins 21-26 is high
kadonotakashi 0:8fdf9a60065b 36 *
kadonotakashi 0:8fdf9a60065b 37 * #include "mbed.h"
kadonotakashi 0:8fdf9a60065b 38 *
kadonotakashi 0:8fdf9a60065b 39 * PortIn p(Port2, 0x0000003F); // p21-p26
kadonotakashi 0:8fdf9a60065b 40 * DigitalOut ind(LED4);
kadonotakashi 0:8fdf9a60065b 41 *
kadonotakashi 0:8fdf9a60065b 42 * int main() {
kadonotakashi 0:8fdf9a60065b 43 * while(1) {
kadonotakashi 0:8fdf9a60065b 44 * int pins = p.read();
kadonotakashi 0:8fdf9a60065b 45 * if(pins) {
kadonotakashi 0:8fdf9a60065b 46 * ind = 1;
kadonotakashi 0:8fdf9a60065b 47 * } else {
kadonotakashi 0:8fdf9a60065b 48 * ind = 0;
kadonotakashi 0:8fdf9a60065b 49 * }
kadonotakashi 0:8fdf9a60065b 50 * }
kadonotakashi 0:8fdf9a60065b 51 * }
kadonotakashi 0:8fdf9a60065b 52 * @endcode
kadonotakashi 0:8fdf9a60065b 53 * @ingroup drivers
kadonotakashi 0:8fdf9a60065b 54 */
kadonotakashi 0:8fdf9a60065b 55 class PortIn {
kadonotakashi 0:8fdf9a60065b 56 public:
kadonotakashi 0:8fdf9a60065b 57
kadonotakashi 0:8fdf9a60065b 58 /** Create an PortIn, connected to the specified port
kadonotakashi 0:8fdf9a60065b 59 *
kadonotakashi 0:8fdf9a60065b 60 * @param port Port to connect to (Port0-Port5)
kadonotakashi 0:8fdf9a60065b 61 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
kadonotakashi 0:8fdf9a60065b 62 */
kadonotakashi 0:8fdf9a60065b 63 PortIn(PortName port, int mask = 0xFFFFFFFF)
kadonotakashi 0:8fdf9a60065b 64 {
kadonotakashi 0:8fdf9a60065b 65 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 66 port_init(&_port, port, mask, PIN_INPUT);
kadonotakashi 0:8fdf9a60065b 67 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 68 }
kadonotakashi 0:8fdf9a60065b 69
kadonotakashi 0:8fdf9a60065b 70 /** Read the value currently output on the port
kadonotakashi 0:8fdf9a60065b 71 *
kadonotakashi 0:8fdf9a60065b 72 * @returns
kadonotakashi 0:8fdf9a60065b 73 * An integer with each bit corresponding to associated port pin setting
kadonotakashi 0:8fdf9a60065b 74 */
kadonotakashi 0:8fdf9a60065b 75 int read()
kadonotakashi 0:8fdf9a60065b 76 {
kadonotakashi 0:8fdf9a60065b 77 return port_read(&_port);
kadonotakashi 0:8fdf9a60065b 78 }
kadonotakashi 0:8fdf9a60065b 79
kadonotakashi 0:8fdf9a60065b 80 /** Set the input pin mode
kadonotakashi 0:8fdf9a60065b 81 *
kadonotakashi 0:8fdf9a60065b 82 * @param mode PullUp, PullDown, PullNone, OpenDrain
kadonotakashi 0:8fdf9a60065b 83 */
kadonotakashi 0:8fdf9a60065b 84 void mode(PinMode mode)
kadonotakashi 0:8fdf9a60065b 85 {
kadonotakashi 0:8fdf9a60065b 86 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 87 port_mode(&_port, mode);
kadonotakashi 0:8fdf9a60065b 88 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 89 }
kadonotakashi 0:8fdf9a60065b 90
kadonotakashi 0:8fdf9a60065b 91 /** A shorthand for read()
kadonotakashi 0:8fdf9a60065b 92 */
kadonotakashi 0:8fdf9a60065b 93 operator int()
kadonotakashi 0:8fdf9a60065b 94 {
kadonotakashi 0:8fdf9a60065b 95 return read();
kadonotakashi 0:8fdf9a60065b 96 }
kadonotakashi 0:8fdf9a60065b 97
kadonotakashi 0:8fdf9a60065b 98 private:
kadonotakashi 0:8fdf9a60065b 99 port_t _port;
kadonotakashi 0:8fdf9a60065b 100 };
kadonotakashi 0:8fdf9a60065b 101
kadonotakashi 0:8fdf9a60065b 102 } // namespace mbed
kadonotakashi 0:8fdf9a60065b 103
kadonotakashi 0:8fdf9a60065b 104 #endif
kadonotakashi 0:8fdf9a60065b 105
kadonotakashi 0:8fdf9a60065b 106 #endif