Example egpc - Revision history

Bserrano at 17:19, 10 April 2014

2014-04-10T17:19:58Z

Bserrano at 21:44, 27 March 2014

2014-03-27T21:44:57Z

Bserrano at 21:43, 27 March 2014

2014-03-27T21:43:27Z

Mdean: tag mayhem

2014-03-25T22:51:41Z

tag mayhem

Mdean: Fixed tag.

2014-03-25T22:29:28Z

Fixed tag.

Mdean: Added note.

2014-03-24T22:23:04Z

Added note.

Mdean: Put new uploading text into place.

2014-01-04T00:28:39Z

Put new uploading text into place.

Kyoungmeyer at 17:20, 2 January 2014

2014-01-02T17:20:02Z

Mdean: Made various improvements and marked FinalDraft.

2013-12-30T23:18:28Z

Made various improvements and marked FinalDraft.

Mdean: /* Hardware Requirements */ Increased visibility of note.

2013-12-30T22:58:30Z

‎Hardware Requirements: Increased visibility of note.

@@ Line 1: / Line 1: @@
-{{todo|SEOKWREV - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+);(03.27.14-16:45->BS+)|Jgreene|project=oe 4,oe 5,jg,md,bs,SEOKWREV}}
+{{todo|SEOKWREV - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+);(03.27.14-16:45->BS+);(04.10.14-12:20->BS+)|Jgreene|project=oe 4,oe 5,jg,md,bs,SEOKWREV}}
@@ Line 5: / Line 5: @@
 |title=Example egpc
 |titlemode=append
-|keywords=Example egpc,Using egpc,Port Configuration,Port Data,Port Index
+|keywords=Port Configuration,Port Data,Port Index,GPIO
 |description=This is a guide to the egpc C example project included in the EMAC OE SDK.
 }}

← Older revision		Revision as of 21:44, 27 March 2014
Line 1:		Line 1:
−	{{todo\|~~Complete~~ - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,~~complete~~}}	+	{{todo\|SEOKWREV - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+);(03.27.14-16:45->BS+)\|Jgreene\|project=oe 4,oe 5,jg,md,bs,SEOKWREV}}

← Older revision		Revision as of 21:43, 27 March 2014
Line 1:		Line 1:
	{{todo\|Complete - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}		{{todo\|Complete - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}
		+
		+
		+	{{#seo:
		+	\|title=Example egpc
		+	\|titlemode=append
		+	\|keywords=Example egpc,Using egpc,Port Configuration,Port Data,Port Index
		+	\|description=This is a guide to the egpc C example project included in the EMAC OE SDK.
		+	}}
	This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.

← Older revision		Revision as of 22:51, 25 March 2014
Line 1:		Line 1:
−	{{todo\|Complete - revise for 5.0 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}	+	{{todo\|Complete - revise for 5.00 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}
	This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.

← Older revision		Revision as of 22:29, 25 March 2014
Line 1:		Line 1:
−	{{todo\|Complete - revise for 5 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}	+	{{todo\|Complete - revise for 5.0 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}
	This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.

← Older revision		Revision as of 22:23, 24 March 2014
Line 1:		Line 1:
−	{{todo\|Complete (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}	+	{{todo\|Complete - revise for 5 (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}
	This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.

@@ Line 8: / Line 8: @@
 == Opening, Building and Uploading the Project Files ==
-<big>1. Open the C/C++ editing perspective.</big>
+For information on opening the project from within Eclipse, please see [[Importing the EMAC OE SDK Projects with Eclipse]].  Then, follow [[Using the EMAC OE SDK Projects with Eclipse]] for information on how to build, upload and execute the example.
-stub
+Alternatively, the <code>Makefile</code> can be used with the <code>make</code> command from the commandline to build and upload the example.  For more information on this method, please see [[Using EMAC OE SDK Example Projects]].
 ==Usage and Behavior==

← Older revision		Revision as of 17:20, 2 January 2014
Line 1:		Line 1:
−	{{todo\|~~Review~~(12.27.13-14:22->JG+);(12.30.13-17:20->MD+)\|Jgreene\|project=oe 4,oe 5,jg,md,~~FinalDraft~~}}	+	{{todo\|Complete (12.27.13-14:22->JG+);(12.30.13-17:20->MD+);(01.02.14-11:20->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,complete}}
	This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.

@@ Line 1: / Line 1: @@
-{{todo|Review(12.27.13-14:22->JG+)|Jgreene|project=oe 4,oe 5,jg,md,Review}}
+{{todo|Review(12.27.13-14:22->JG+);(12.30.13-17:20->MD+)|Jgreene|project=oe 4,oe 5,jg,md,FinalDraft}}
 This is a guide to the <code>egpc</code> C example project included in the EMAC OE SDK.
-<code>egpc</code> is an application for reading/writing/configuring gpio character devices. Specifically, we read/write/configure the 3 ports (ports A, B and C) on the GPIO header.
+<code>egpc</code> is an application for reading/writing/configuring gpio character devices. Specifically, it will read/write/configure the 3 ports (ports '''A''', '''B''' and '''C''') on the GPIO header.
 The <code>egpc</code> project builds one executable: <code>egpc</code>.
@@ Line 30: / Line 30: @@
 ===Hardware Requirements===
-The <code>egpc</code> C example project will run on any EMAC carrier board.
+The <code>egpc</code> C example project will run on any EMAC carrier board which has one or more GPIO.
 ===Using <code>egpc</code>===
-  ./egpc device d/c/i (arg)
+  ./egpc ''device'' ''[d/c/i]'' ''arg''
-'''device''' is /dev/porta, /dev/portb or /dev/portc<br />
+''device'' is <code>/dev/porta</code>, <code>/dev/portb</code> or <code>/dev/portc</code><br />
-'''d/c/i''' specifies the port command : d(data), c(configure) or i(index)<br />
+''d/c/i'' specifies the port command : <code>d</code> (data), <code>c</code> (configure) or <code>i</code> (index)<br />
-'''arg''' is either a port index or a bitmask. The bitmask is in hex format, range [0x0,0xff].
+''arg'' is either a port index or a bitmask. The bitmask is in hex format, range <code>[0x00,0xff]</code>.
 ===Usage Example. Port Configuration===
-  ./egpc device c (mask)
+  ./egpc ''device'' c ''[mask]''
-If a mask is specified it configures the pins for input/output.<br />
+If a mask is specified, it configures the pins for input/output.<br />
-If no mask is specified it returns the current configuration.<br />
+If no mask is specified, it returns the current configuration.<br />
-'''mask''' is an input/output bitmask. 1=output and 0=input.<br />
+''mask'' is an input/output bitmask. <code>1</code>=output and <code>0</code>=input.<br />
-For example, this sets every other pin on PortA to be an output.
+For example, this sets every other pin on '''Port A''' to be an output.
   ./egpc /dev/porta c 0xaa
-...and this reads the current pin configuration state of PortA.
+...and this reads the current pin configuration state of '''Port A'''.
   ./egpc /dev/porta c
 xaa
-===Usage Example. Port Data===
+===Usage Example: Port Data===
-  ./egpc device d (mask)
+  ./egpc device d ''[mask]''
 If a mask is specified then it sets each bit's corresponding pin output latch to high/low accordingly.<br />
 If a mask is not specified then the current pin state is retrieved.<br />
-For example, this writes pin output latches on PortC to alternating high and low.
   ./egpc /dev/portc d 0x55
-...and this flips the pins; writing all the pins that we just set to low to high and vice-versa.
+This flips the pins, writing all the pins that were set low in the previous command to high, and vice-versa:
   ./egpc /dev/portc d 0xaa
-...and this reads the current pin data state of PortC.
+This reads the current pin data state of '''Port C'''.
   ./egps /dev/portc d
-'''Note''' The pin values for Port C are displayed on the board's strip of 8 LEDs. Observe that the LEDs change state when we write to Port C. This only works for Port C, however. Ports A and B must be read with an oscilloscope or multimeter.
+The pin values for '''Port C''' are displayed on the board's strip of 8 LEDs. Observe that the LEDs change state when a new value is written to '''Port C'''. This only works for '''Port C''', however. '''Ports A''' and '''B''' must be read with an oscilloscope, multimeter, logic analyzer or similar device.
 ===Usage Example. Port Index===
@@ Line 84: / Line 83: @@
 If an index is specified then it sets the port's index<br />
 If an index is not specified then the port's current index is retrieved.<br />
-For example, this sets the index of PortA to 1
   ./egpc /dev/porta i 1
-...and this reads the current index of PortA
+...and this reads the current index of '''Port A'''
   ./egpc /dev/porta i
@@ Line 94: / Line 94: @@
 ==Summary==
-<code>egpc</code> is an application for reading, writing and configuring the ports on the GPIO header.
+<code>egpc</code> is an application which demonstrates reading, writing and configuring the GPIO ports.

@@ Line 32: / Line 32: @@
 The <code>egpc</code> C example project will run on any EMAC carrier board.
-'''VERIFY THIS'''
+'''>>>>>>>>>>>>>>>>>>>>>> ************************ VERIFY THIS ******************************** <<<<<<<<<<<<<<<<<<<<<<<<'''
 ===Using <code>egpc</code>===