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/PortOut.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_PORTOUT_H
vipinranka 12:9a20164dcc47 17 #define MBED_PORTOUT_H
vipinranka 12:9a20164dcc47 18
vipinranka 12:9a20164dcc47 19 #include "platform/platform.h"
vipinranka 12:9a20164dcc47 20
vipinranka 12:9a20164dcc47 21 #if DEVICE_PORTOUT
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 /** A multiple pin digital out
vipinranka 12:9a20164dcc47 30 *
vipinranka 12:9a20164dcc47 31 * @Note Synchronization level: Interrupt safe
vipinranka 12:9a20164dcc47 32 *
vipinranka 12:9a20164dcc47 33 * Example:
vipinranka 12:9a20164dcc47 34 * @code
vipinranka 12:9a20164dcc47 35 * // Toggle all four LEDs
vipinranka 12:9a20164dcc47 36 *
vipinranka 12:9a20164dcc47 37 * #include "mbed.h"
vipinranka 12:9a20164dcc47 38 *
vipinranka 12:9a20164dcc47 39 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
vipinranka 12:9a20164dcc47 40 * #define LED_MASK 0x00B40000
vipinranka 12:9a20164dcc47 41 *
vipinranka 12:9a20164dcc47 42 * PortOut ledport(Port1, LED_MASK);
vipinranka 12:9a20164dcc47 43 *
vipinranka 12:9a20164dcc47 44 * int main() {
vipinranka 12:9a20164dcc47 45 * while(1) {
vipinranka 12:9a20164dcc47 46 * ledport = LED_MASK;
vipinranka 12:9a20164dcc47 47 * wait(1);
vipinranka 12:9a20164dcc47 48 * ledport = 0;
vipinranka 12:9a20164dcc47 49 * wait(1);
vipinranka 12:9a20164dcc47 50 * }
vipinranka 12:9a20164dcc47 51 * }
vipinranka 12:9a20164dcc47 52 * @endcode
vipinranka 12:9a20164dcc47 53 */
vipinranka 12:9a20164dcc47 54 class PortOut {
vipinranka 12:9a20164dcc47 55 public:
vipinranka 12:9a20164dcc47 56
vipinranka 12:9a20164dcc47 57 /** Create an PortOut, connected to the specified port
vipinranka 12:9a20164dcc47 58 *
vipinranka 12:9a20164dcc47 59 * @param port Port to connect to (Port0-Port5)
vipinranka 12:9a20164dcc47 60 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
vipinranka 12:9a20164dcc47 61 */
vipinranka 12:9a20164dcc47 62 PortOut(PortName port, int mask = 0xFFFFFFFF) {
vipinranka 12:9a20164dcc47 63 core_util_critical_section_enter();
vipinranka 12:9a20164dcc47 64 port_init(&_port, port, mask, PIN_OUTPUT);
vipinranka 12:9a20164dcc47 65 core_util_critical_section_exit();
vipinranka 12:9a20164dcc47 66 }
vipinranka 12:9a20164dcc47 67
vipinranka 12:9a20164dcc47 68 /** Write the value to the output port
vipinranka 12:9a20164dcc47 69 *
vipinranka 12:9a20164dcc47 70 * @param value An integer specifying a bit to write for every corresponding PortOut pin
vipinranka 12:9a20164dcc47 71 */
vipinranka 12:9a20164dcc47 72 void write(int value) {
vipinranka 12:9a20164dcc47 73 port_write(&_port, value);
vipinranka 12:9a20164dcc47 74 }
vipinranka 12:9a20164dcc47 75
vipinranka 12:9a20164dcc47 76 /** Read the value currently output on the port
vipinranka 12:9a20164dcc47 77 *
vipinranka 12:9a20164dcc47 78 * @returns
vipinranka 12:9a20164dcc47 79 * An integer with each bit corresponding to associated PortOut pin setting
vipinranka 12:9a20164dcc47 80 */
vipinranka 12:9a20164dcc47 81 int read() {
vipinranka 12:9a20164dcc47 82 return port_read(&_port);
vipinranka 12:9a20164dcc47 83 }
vipinranka 12:9a20164dcc47 84
vipinranka 12:9a20164dcc47 85 /** A shorthand for write()
vipinranka 12:9a20164dcc47 86 */
vipinranka 12:9a20164dcc47 87 PortOut& operator= (int value) {
vipinranka 12:9a20164dcc47 88 write(value);
vipinranka 12:9a20164dcc47 89 return *this;
vipinranka 12:9a20164dcc47 90 }
vipinranka 12:9a20164dcc47 91
vipinranka 12:9a20164dcc47 92 PortOut& operator= (PortOut& rhs) {
vipinranka 12:9a20164dcc47 93 write(rhs.read());
vipinranka 12:9a20164dcc47 94 return *this;
vipinranka 12:9a20164dcc47 95 }
vipinranka 12:9a20164dcc47 96
vipinranka 12:9a20164dcc47 97 /** A shorthand for read()
vipinranka 12:9a20164dcc47 98 */
vipinranka 12:9a20164dcc47 99 operator int() {
vipinranka 12:9a20164dcc47 100 return read();
vipinranka 12:9a20164dcc47 101 }
vipinranka 12:9a20164dcc47 102
vipinranka 12:9a20164dcc47 103 private:
vipinranka 12:9a20164dcc47 104 port_t _port;
vipinranka 12:9a20164dcc47 105 };
vipinranka 12:9a20164dcc47 106
vipinranka 12:9a20164dcc47 107 } // namespace mbed
vipinranka 12:9a20164dcc47 108
vipinranka 12:9a20164dcc47 109 #endif
vipinranka 12:9a20164dcc47 110
vipinranka 12:9a20164dcc47 111 #endif
vipinranka 12:9a20164dcc47 112
vipinranka 12:9a20164dcc47 113 /** @}*/