Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/PortOut.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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