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/BusInOut.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_BUSINOUT_H
vipinranka 12:9a20164dcc47 17 #define MBED_BUSINOUT_H
vipinranka 12:9a20164dcc47 18
vipinranka 12:9a20164dcc47 19 #include "drivers/DigitalInOut.h"
vipinranka 12:9a20164dcc47 20 #include "platform/PlatformMutex.h"
vipinranka 12:9a20164dcc47 21
vipinranka 12:9a20164dcc47 22 namespace mbed {
vipinranka 12:9a20164dcc47 23 /** \addtogroup drivers */
vipinranka 12:9a20164dcc47 24 /** @{*/
vipinranka 12:9a20164dcc47 25
vipinranka 12:9a20164dcc47 26 /** A digital input output bus, used for setting the state of a collection of pins
vipinranka 12:9a20164dcc47 27 *
vipinranka 12:9a20164dcc47 28 * @Note Synchronization level: Thread safe
vipinranka 12:9a20164dcc47 29 */
vipinranka 12:9a20164dcc47 30 class BusInOut {
vipinranka 12:9a20164dcc47 31
vipinranka 12:9a20164dcc47 32 public:
vipinranka 12:9a20164dcc47 33
vipinranka 12:9a20164dcc47 34 /** Create an BusInOut, connected to the specified pins
vipinranka 12:9a20164dcc47 35 *
vipinranka 12:9a20164dcc47 36 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
vipinranka 12:9a20164dcc47 37 *
vipinranka 12:9a20164dcc47 38 * @note
vipinranka 12:9a20164dcc47 39 * It is only required to specify as many pin variables as is required
vipinranka 12:9a20164dcc47 40 * for the bus; the rest will default to NC (not connected)
vipinranka 12:9a20164dcc47 41 */
vipinranka 12:9a20164dcc47 42 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
vipinranka 12:9a20164dcc47 43 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
vipinranka 12:9a20164dcc47 44 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
vipinranka 12:9a20164dcc47 45 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
vipinranka 12:9a20164dcc47 46
vipinranka 12:9a20164dcc47 47 BusInOut(PinName pins[16]);
vipinranka 12:9a20164dcc47 48
vipinranka 12:9a20164dcc47 49 virtual ~BusInOut();
vipinranka 12:9a20164dcc47 50
vipinranka 12:9a20164dcc47 51 /* Group: Access Methods */
vipinranka 12:9a20164dcc47 52
vipinranka 12:9a20164dcc47 53 /** Write the value to the output bus
vipinranka 12:9a20164dcc47 54 *
vipinranka 12:9a20164dcc47 55 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
vipinranka 12:9a20164dcc47 56 */
vipinranka 12:9a20164dcc47 57 void write(int value);
vipinranka 12:9a20164dcc47 58
vipinranka 12:9a20164dcc47 59 /** Read the value currently output on the bus
vipinranka 12:9a20164dcc47 60 *
vipinranka 12:9a20164dcc47 61 * @returns
vipinranka 12:9a20164dcc47 62 * An integer with each bit corresponding to associated DigitalInOut pin setting
vipinranka 12:9a20164dcc47 63 */
vipinranka 12:9a20164dcc47 64 int read();
vipinranka 12:9a20164dcc47 65
vipinranka 12:9a20164dcc47 66 /** Set as an output
vipinranka 12:9a20164dcc47 67 */
vipinranka 12:9a20164dcc47 68 void output();
vipinranka 12:9a20164dcc47 69
vipinranka 12:9a20164dcc47 70 /** Set as an input
vipinranka 12:9a20164dcc47 71 */
vipinranka 12:9a20164dcc47 72 void input();
vipinranka 12:9a20164dcc47 73
vipinranka 12:9a20164dcc47 74 /** Set the input pin mode
vipinranka 12:9a20164dcc47 75 *
vipinranka 12:9a20164dcc47 76 * @param mode PullUp, PullDown, PullNone
vipinranka 12:9a20164dcc47 77 */
vipinranka 12:9a20164dcc47 78 void mode(PinMode pull);
vipinranka 12:9a20164dcc47 79
vipinranka 12:9a20164dcc47 80 /** Binary mask of bus pins connected to actual pins (not NC pins)
vipinranka 12:9a20164dcc47 81 * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
vipinranka 12:9a20164dcc47 82 *
vipinranka 12:9a20164dcc47 83 * @returns
vipinranka 12:9a20164dcc47 84 * Binary mask of connected pins
vipinranka 12:9a20164dcc47 85 */
vipinranka 12:9a20164dcc47 86 int mask() {
vipinranka 12:9a20164dcc47 87 // No lock needed since _nc_mask is not modified outside the constructor
vipinranka 12:9a20164dcc47 88 return _nc_mask;
vipinranka 12:9a20164dcc47 89 }
vipinranka 12:9a20164dcc47 90
vipinranka 12:9a20164dcc47 91 /** A shorthand for write()
vipinranka 12:9a20164dcc47 92 */
vipinranka 12:9a20164dcc47 93 BusInOut& operator= (int v);
vipinranka 12:9a20164dcc47 94 BusInOut& operator= (BusInOut& rhs);
vipinranka 12:9a20164dcc47 95
vipinranka 12:9a20164dcc47 96 /** Access to particular bit in random-iterator fashion
vipinranka 12:9a20164dcc47 97 */
vipinranka 12:9a20164dcc47 98 DigitalInOut& operator[] (int index);
vipinranka 12:9a20164dcc47 99
vipinranka 12:9a20164dcc47 100 /** A shorthand for read()
vipinranka 12:9a20164dcc47 101 */
vipinranka 12:9a20164dcc47 102 operator int();
vipinranka 12:9a20164dcc47 103
vipinranka 12:9a20164dcc47 104 protected:
vipinranka 12:9a20164dcc47 105 virtual void lock();
vipinranka 12:9a20164dcc47 106 virtual void unlock();
vipinranka 12:9a20164dcc47 107 DigitalInOut* _pin[16];
vipinranka 12:9a20164dcc47 108
vipinranka 12:9a20164dcc47 109 /** Mask of bus's NC pins
vipinranka 12:9a20164dcc47 110 * If bit[n] is set to 1 - pin is connected
vipinranka 12:9a20164dcc47 111 * if bit[n] is cleared - pin is not connected (NC)
vipinranka 12:9a20164dcc47 112 */
vipinranka 12:9a20164dcc47 113 int _nc_mask;
vipinranka 12:9a20164dcc47 114
vipinranka 12:9a20164dcc47 115 PlatformMutex _mutex;
vipinranka 12:9a20164dcc47 116
vipinranka 12:9a20164dcc47 117 /* disallow copy constructor and assignment operators */
vipinranka 12:9a20164dcc47 118 private:
vipinranka 12:9a20164dcc47 119 BusInOut(const BusInOut&);
vipinranka 12:9a20164dcc47 120 BusInOut & operator = (const BusInOut&);
vipinranka 12:9a20164dcc47 121 };
vipinranka 12:9a20164dcc47 122
vipinranka 12:9a20164dcc47 123 } // namespace mbed
vipinranka 12:9a20164dcc47 124
vipinranka 12:9a20164dcc47 125 #endif
vipinranka 12:9a20164dcc47 126
vipinranka 12:9a20164dcc47 127 /** @}*/