ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #8419 from TacoGrandeTX/doc_fix_portin 

PortIn.h: Documentation improvements only
pull/8446/head
Cruz Monrreal 2018-10-16 16:18:50 -05:00 committed by GitHub
parent adf9165af2 bdcf24b82f
commit 996a31f9d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
drivers/PortIn.h
View File

@ -32,20 +32,20 @@ namespace mbed {
* *
* Example: * Example:
* @code * @code
* // Switch on an LED if any of mbed pins 21-26 is high * // Turn on an LED if any pins of Port2[0:5] are high
* *
* #include "mbed.h" * #include "mbed.h"
* *
* PortIn p(Port2, 0x0000003F); // p21-p26 * PortIn p(Port2, 0x0000003F); // Port2 pins [0:5] only
* DigitalOut ind(LED4); * DigitalOut led(LED4);
* *
* int main() { * int main() {
* while(1) { * while(1) {
* int pins = p.read(); * int pins = p.read();
* if(pins) { * if(pins) {
* ind = 1; * led = 1;
* } else { * } else {
* ind = 0; * led = 0;
* } * }
* } * }
* } * }
@ -55,10 +55,10 @@ namespace mbed {
class PortIn { class PortIn {
public: public:
/** Create an PortIn, connected to the specified port /** Create a PortIn, connected to the specified port
* *
* @param port Port to connect to (Port0-Port5) * @param port Port to connect to (as defined in target's PortNames.h)
* @param mask A bitmask to identify which bits in the port should be included (0 - ignore) * @param mask Bitmask defines which port pins should be an input (0 - ignore, 1 - include)
*/ */
PortIn(PortName port, int mask = 0xFFFFFFFF) PortIn(PortName port, int mask = 0xFFFFFFFF)
{ {
@ -67,10 +67,10 @@ public:
core_util_critical_section_exit(); core_util_critical_section_exit();
} }
/** Read the value currently output on the port /** Read the value input to the port
* *
* @returns * @returns
* An integer with each bit corresponding to associated port pin setting * An integer with each bit corresponding to the associated pin value
*/ */
int read() int read()
{ {