Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

PortOut.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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