ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/PortIn.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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