Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/PortIn.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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