siva surendar / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

drivers/PortOut.h@150:da61ba4e9755, 2016-11-25 (annotated)

Committer:
sivasuren
Date:
Fri Nov 25 07:57:40 2016 +0000
Revision:
150:da61ba4e9755
Parent:
149:156823d33999 
surendar changes

Who changed what in which revision?

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