Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

PortIn.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_PORTIN_H
jhon309 0:ac8863619623 17 #define MBED_PORTIN_H
jhon309 0:ac8863619623 18
jhon309 0:ac8863619623 19 #include "platform.h"
jhon309 0:ac8863619623 20
jhon309 0:ac8863619623 21 #if DEVICE_PORTIN
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
jhon309 0:ac8863619623 27 /** A multiple pin digital input
jhon309 0:ac8863619623 28 *
jhon309 0:ac8863619623 29 * Example:
jhon309 0:ac8863619623 30 * @code
jhon309 0:ac8863619623 31 * // Switch on an LED if any of mbed pins 21-26 is high
jhon309 0:ac8863619623 32 *
jhon309 0:ac8863619623 33 * #include "mbed.h"
jhon309 0:ac8863619623 34 *
jhon309 0:ac8863619623 35 * PortIn p(Port2, 0x0000003F); // p21-p26
jhon309 0:ac8863619623 36 * DigitalOut ind(LED4);
jhon309 0:ac8863619623 37 *
jhon309 0:ac8863619623 38 * int main() {
jhon309 0:ac8863619623 39 * while(1) {
jhon309 0:ac8863619623 40 * int pins = p.read();
jhon309 0:ac8863619623 41 * if(pins) {
jhon309 0:ac8863619623 42 * ind = 1;
jhon309 0:ac8863619623 43 * } else {
jhon309 0:ac8863619623 44 * ind = 0;
jhon309 0:ac8863619623 45 * }
jhon309 0:ac8863619623 46 * }
jhon309 0:ac8863619623 47 * }
jhon309 0:ac8863619623 48 * @endcode
jhon309 0:ac8863619623 49 */
jhon309 0:ac8863619623 50 class PortIn {
jhon309 0:ac8863619623 51 public:
jhon309 0:ac8863619623 52
jhon309 0:ac8863619623 53 /** Create an PortIn, connected to the specified port
jhon309 0:ac8863619623 54 *
jhon309 0:ac8863619623 55 * @param port Port to connect to (Port0-Port5)
jhon309 0:ac8863619623 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
jhon309 0:ac8863619623 57 */
jhon309 0:ac8863619623 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
jhon309 0:ac8863619623 59 port_init(&_port, port, mask, PIN_INPUT);
jhon309 0:ac8863619623 60 }
jhon309 0:ac8863619623 61
jhon309 0:ac8863619623 62 /** Read the value currently output on the port
jhon309 0:ac8863619623 63 *
jhon309 0:ac8863619623 64 * @returns
jhon309 0:ac8863619623 65 * An integer with each bit corresponding to associated port pin setting
jhon309 0:ac8863619623 66 */
jhon309 0:ac8863619623 67 int read() {
jhon309 0:ac8863619623 68 return port_read(&_port);
jhon309 0:ac8863619623 69 }
jhon309 0:ac8863619623 70
jhon309 0:ac8863619623 71 /** Set the input pin mode
jhon309 0:ac8863619623 72 *
jhon309 0:ac8863619623 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
jhon309 0:ac8863619623 74 */
jhon309 0:ac8863619623 75 void mode(PinMode mode) {
jhon309 0:ac8863619623 76 port_mode(&_port, mode);
jhon309 0:ac8863619623 77 }
jhon309 0:ac8863619623 78
jhon309 0:ac8863619623 79 /** A shorthand for read()
jhon309 0:ac8863619623 80 */
jhon309 0:ac8863619623 81 operator int() {
jhon309 0:ac8863619623 82 return read();
jhon309 0:ac8863619623 83 }
jhon309 0:ac8863619623 84
jhon309 0:ac8863619623 85 private:
jhon309 0:ac8863619623 86 port_t _port;
jhon309 0:ac8863619623 87 };
jhon309 0:ac8863619623 88
jhon309 0:ac8863619623 89 } // namespace mbed
jhon309 0:ac8863619623 90
jhon309 0:ac8863619623 91 #endif
jhon309 0:ac8863619623 92
jhon309 0:ac8863619623 93 #endif