Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

PortOut.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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