Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/PortOut.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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