Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/PortInOut.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dkato 0:f782d9c66c49 1 /* mbed Microcontroller Library
dkato 0:f782d9c66c49 2 * Copyright (c) 2006-2013 ARM Limited
dkato 0:f782d9c66c49 3 *
dkato 0:f782d9c66c49 4 * Licensed under the Apache License, Version 2.0 (the "License");
dkato 0:f782d9c66c49 5 * you may not use this file except in compliance with the License.
dkato 0:f782d9c66c49 6 * You may obtain a copy of the License at
dkato 0:f782d9c66c49 7 *
dkato 0:f782d9c66c49 8 * http://www.apache.org/licenses/LICENSE-2.0
dkato 0:f782d9c66c49 9 *
dkato 0:f782d9c66c49 10 * Unless required by applicable law or agreed to in writing, software
dkato 0:f782d9c66c49 11 * distributed under the License is distributed on an "AS IS" BASIS,
dkato 0:f782d9c66c49 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dkato 0:f782d9c66c49 13 * See the License for the specific language governing permissions and
dkato 0:f782d9c66c49 14 * limitations under the License.
dkato 0:f782d9c66c49 15 */
dkato 0:f782d9c66c49 16 #ifndef MBED_PORTINOUT_H
dkato 0:f782d9c66c49 17 #define MBED_PORTINOUT_H
dkato 0:f782d9c66c49 18
dkato 0:f782d9c66c49 19 #include "platform/platform.h"
dkato 0:f782d9c66c49 20
dkato 0:f782d9c66c49 21 #if DEVICE_PORTINOUT
dkato 0:f782d9c66c49 22
dkato 0:f782d9c66c49 23 #include "hal/port_api.h"
dkato 0:f782d9c66c49 24 #include "platform/mbed_critical.h"
dkato 0:f782d9c66c49 25
dkato 0:f782d9c66c49 26 namespace mbed {
dkato 0:f782d9c66c49 27 /** \addtogroup drivers */
dkato 0:f782d9c66c49 28 /** @{*/
dkato 0:f782d9c66c49 29
dkato 0:f782d9c66c49 30 /** A multiple pin digital in/out used to set/read multiple bi-directional pins
dkato 0:f782d9c66c49 31 *
dkato 0:f782d9c66c49 32 * @Note Synchronization level: Interrupt safe
dkato 0:f782d9c66c49 33 */
dkato 0:f782d9c66c49 34 class PortInOut {
dkato 0:f782d9c66c49 35 public:
dkato 0:f782d9c66c49 36
dkato 0:f782d9c66c49 37 /** Create an PortInOut, connected to the specified port
dkato 0:f782d9c66c49 38 *
dkato 0:f782d9c66c49 39 * @param port Port to connect to (Port0-Port5)
dkato 0:f782d9c66c49 40 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
dkato 0:f782d9c66c49 41 */
dkato 0:f782d9c66c49 42 PortInOut(PortName port, int mask = 0xFFFFFFFF) {
dkato 0:f782d9c66c49 43 core_util_critical_section_enter();
dkato 0:f782d9c66c49 44 port_init(&_port, port, mask, PIN_INPUT);
dkato 0:f782d9c66c49 45 core_util_critical_section_exit();
dkato 0:f782d9c66c49 46 }
dkato 0:f782d9c66c49 47
dkato 0:f782d9c66c49 48 /** Write the value to the output port
dkato 0:f782d9c66c49 49 *
dkato 0:f782d9c66c49 50 * @param value An integer specifying a bit to write for every corresponding port pin
dkato 0:f782d9c66c49 51 */
dkato 0:f782d9c66c49 52 void write(int value) {
dkato 0:f782d9c66c49 53 port_write(&_port, value);
dkato 0:f782d9c66c49 54 }
dkato 0:f782d9c66c49 55
dkato 0:f782d9c66c49 56 /** Read the value currently output on the port
dkato 0:f782d9c66c49 57 *
dkato 0:f782d9c66c49 58 * @returns
dkato 0:f782d9c66c49 59 * An integer with each bit corresponding to associated port pin setting
dkato 0:f782d9c66c49 60 */
dkato 0:f782d9c66c49 61 int read() {
dkato 0:f782d9c66c49 62 return port_read(&_port);
dkato 0:f782d9c66c49 63 }
dkato 0:f782d9c66c49 64
dkato 0:f782d9c66c49 65 /** Set as an output
dkato 0:f782d9c66c49 66 */
dkato 0:f782d9c66c49 67 void output() {
dkato 0:f782d9c66c49 68 core_util_critical_section_enter();
dkato 0:f782d9c66c49 69 port_dir(&_port, PIN_OUTPUT);
dkato 0:f782d9c66c49 70 core_util_critical_section_exit();
dkato 0:f782d9c66c49 71 }
dkato 0:f782d9c66c49 72
dkato 0:f782d9c66c49 73 /** Set as an input
dkato 0:f782d9c66c49 74 */
dkato 0:f782d9c66c49 75 void input() {
dkato 0:f782d9c66c49 76 core_util_critical_section_enter();
dkato 0:f782d9c66c49 77 port_dir(&_port, PIN_INPUT);
dkato 0:f782d9c66c49 78 core_util_critical_section_exit();
dkato 0:f782d9c66c49 79 }
dkato 0:f782d9c66c49 80
dkato 0:f782d9c66c49 81 /** Set the input pin mode
dkato 0:f782d9c66c49 82 *
dkato 0:f782d9c66c49 83 * @param mode PullUp, PullDown, PullNone, OpenDrain
dkato 0:f782d9c66c49 84 */
dkato 0:f782d9c66c49 85 void mode(PinMode mode) {
dkato 0:f782d9c66c49 86 core_util_critical_section_enter();
dkato 0:f782d9c66c49 87 port_mode(&_port, mode);
dkato 0:f782d9c66c49 88 core_util_critical_section_exit();
dkato 0:f782d9c66c49 89 }
dkato 0:f782d9c66c49 90
dkato 0:f782d9c66c49 91 /** A shorthand for write()
dkato 0:f782d9c66c49 92 */
dkato 0:f782d9c66c49 93 PortInOut& operator= (int value) {
dkato 0:f782d9c66c49 94 write(value);
dkato 0:f782d9c66c49 95 return *this;
dkato 0:f782d9c66c49 96 }
dkato 0:f782d9c66c49 97
dkato 0:f782d9c66c49 98 PortInOut& operator= (PortInOut& rhs) {
dkato 0:f782d9c66c49 99 write(rhs.read());
dkato 0:f782d9c66c49 100 return *this;
dkato 0:f782d9c66c49 101 }
dkato 0:f782d9c66c49 102
dkato 0:f782d9c66c49 103 /** A shorthand for read()
dkato 0:f782d9c66c49 104 */
dkato 0:f782d9c66c49 105 operator int() {
dkato 0:f782d9c66c49 106 return read();
dkato 0:f782d9c66c49 107 }
dkato 0:f782d9c66c49 108
dkato 0:f782d9c66c49 109 private:
dkato 0:f782d9c66c49 110 port_t _port;
dkato 0:f782d9c66c49 111 };
dkato 0:f782d9c66c49 112
dkato 0:f782d9c66c49 113 } // namespace mbed
dkato 0:f782d9c66c49 114
dkato 0:f782d9c66c49 115 #endif
dkato 0:f782d9c66c49 116
dkato 0:f782d9c66c49 117 #endif
dkato 0:f782d9c66c49 118
dkato 0:f782d9c66c49 119 /** @}*/