Add some help using the gpio commands at runtime
PATCH 1/1 Add some help using the gpio commands at runtime
From: Juergen Beisert <[email protected]>
Subject: [PATCH] Add some help using the gpio commands at runtime
Last time I used the gpio commands I was somehow confused about the behaviour of the 'gpio_get_value' command. So, I decided to add some doc for it. Here's the result.
--- Documentation/commands.dox | 1 commands/gpio.c | 61 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+)
Documentation/commands.dox +1 -0
@@ -10,6 +10,7 @@ @li @subpage edit_command @li @subpage erase_command @li @subpage export_command +@li @subpage gpio_for_users @li @subpage tftp_command @li @subpage loadenv_command @li @subpage mount_command
commands/gpio.c +61 -0
64 lines not on this page · raw message
Signature · 9 lines
Pengutronix e.K. | Juergen Beisert | Linux Solutions for Science and Industry | Phone: +49-8766-939 228 | Vertretung Sued/Muenchen, Germany | Fax: +49-5121-206917-5555 | Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/ | _______________________________________________ barebox mailing list [email protected] http://lists.infradead.org/mailman/listinfo/barebox
Hi,
This is a great step for documentation, and a few things I didn't know. Thanks for the effort!
Just FYI, some really minor corrections below. (Sorry for being pedantic.. I'm OK if they are ignored :) )
Cheers
Marc
Quoted 52 lines
-----Original Message-----
From: [email protected] [mailto:barebox- [email protected]] On Behalf Of Juergen Beisert
Sent: Friday, 22 October 2010 7:58 PM
To: [email protected]
Subject: [PATCH] Add some help using the gpio commands at runtimeFrom: Juergen Beisert <[email protected]>
Subject: [PATCH] Add some help using the gpio commands at runtimeLast time I used the gpio commands I was somehow confused about the behaviour of the '
gpio_get_value' command. So, I decided to add some doc for it. Here's the result.Signed-off-by Juergen Beisert <[email protected]>--- Documentation/commands.dox | 1 commands/gpio.c | 61 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+)Index: barebox-2010.10.0/Documentation/commands.dox
==========================================================
=========Documentation/commands.dox +1
-0@@ -10,6 +10,7 @@ @li @subpage edit_command @li @subpage erase_command @li @subpage export_command +@li @subpage gpio_for_users @li @subpage tftp_command @li @subpage loadenv_command @li @subpage mount_commandIndex:
barebox-2010.10.0/commands/gpio.c
==========================================================
=========commands/gpio.c +6
-0@@ -120,3 +120,64 @@ BAREBOX_CMD_START(gpio_direction_output)BAREBOX_CMD_HELP (cmd_gpio_direction_output_help)BAREBOX_CMD_END +/** +@page gpio_for_users Runtime GPIO handling + +@section regular_gpio General usage information + +These commands are available if the symbol @b CONFIG_GENERIC_GPIO and
+@bCONFIG_CMD_GPIOare enabled in theKconfig.
commands/gpio.c BAREBOX_CMD_START(gpio_direction_output)
Quoted 3 lines
commands/gpio.c +3
-0+ +@note All gpio related commands take a number to identify the pad. This +number is architecture dependend. There may be no intuitional
s/dependend/dependent
commands/gpio.c
Quoted 2 lines
commands/gpio.c +2
-0+correlation between available pads and the GPIO numbers to be used in +the commands. Due to this its also possible the numbers change between
s/its/it's
Quoted 26 lines
@b barebox releases.
commands/gpio.c +25
-0+ +@section gpio_dir_out Switch a pad into an output GPIO @verbatim +gpio_direction_output <gpio_no> <initial_value> @endverbatim +- @b gpio_no Architecture dependend GPIO number +- @b initial_value Output value the pad should emit + +@note To avoid glitches on the pad's line, the routines will first +setting up the pad's value and after that switching the pad itself to +output (if the silicon is able to do so) + +@note If the pad is already configured into a non GPIO mode (if +available) this command may fail (silently) + +@section gpio_dir_in Switch a pad into an input GPIO @verbatim +gpio_direction_input <gpio_no> @endverbatim +- @b gpio_no Architecture dependend GPIO number + +@note If the pad is already configured into a non GPIO mode (if +available) this command may fail (silently) + +@section gpio_get_value Read in the value of an GPIO input pad +@verbatim gpio_get_value <gpio_no> @endverbatim + +Reads in the current pad's line value from the given GPIO number. It +returns the value as a shell return code. There is no visible output at
commands/gpio.c BAREBOX_CMD_START(gpio_direction_output) · line 177
Quoted 10 lines
commands/gpio.c +10
-0+stdout. You can check the return value by using "echo $?" + +@note If the return code is not '0' or '1' it's meant as an error code. + +@note If the pad is not configured for GPIO mode this command may fail +(silently) and returns garbage + +@section gpio_set_value Set a new value to a GPIO output pad @verbatim +gpio_set_value <gpio_no> <value> @endverbatim +- @b gpio_no Architecture dependend GPIO number
s/dependend/dependent
Quoted 9 lines
+- @b value Output value the pad should emit
commands/gpio.c +5
-1+ +Sets a new output @b value to the pad with GPIO number @b gpio_no + +@note If the pad is not configured for GPIO mode this command may fail +(silently) */ --Pengutronix e.K. | Juergen Beisert
|
Quoted 1 line
Linux Solutions for Science and Industry | Phone: +49-8766-939 228
|
Quoted 1 line
Vertretung Sued/Muenchen, Germany | Fax:
+49-5121-206917-5555 |
Quoted 1 line
Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/
|
Quoted 5 lines
_______________________________________________
barebox mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/barebox
_______________________________________________
barebox mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/barebox
Hi Marc,
Quoted 5 lines · Marc Reilly
This is a great step for documentation, and a few things I didn't know. Thanks for the effort!
Just FYI, some really minor corrections below. (Sorry for being pedantic.. I'm OK if they are ignored :) )
Thank you for the corrections. I will re-send the patch.
jbe
Signature · 9 lines
Pengutronix e.K. | Juergen Beisert | Linux Solutions for Science and Industry | Phone: +49-8766-939 228 | Vertretung Sued/Muenchen, Germany | Fax: +49-5121-206917-5555 | Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/ | _______________________________________________ barebox mailing list [email protected] http://lists.infradead.org/mailman/listinfo/barebox
PATCH v2 1/1 Add some help using the gpio commands at runtime
In reply to Marc ReillyFrom: Juergen Beisert <[email protected]>
Subject: [PATCH] Add some help using the gpio commands at runtime
Last time I used the gpio commands I was somehow confused about the behaviour of the 'gpio_get_value' command. So, I decided to add some doc for it. Here's the result.
--- Documentation/commands.dox | 1 commands/gpio.c | 61 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+)
Documentation/commands.dox +1 -0
@@ -10,6 +10,7 @@ @li @subpage edit_command @li @subpage erase_command @li @subpage export_command +@li @subpage gpio_for_users @li @subpage tftp_command @li @subpage loadenv_command @li @subpage mount_command
commands/gpio.c +60 -0
63 lines not on this page · raw message
(silently)
+*/
Signature · 9 lines
Pengutronix e.K. | Juergen Beisert | Linux Solutions for Science and Industry | Phone: +49-8766-939 228 | Vertretung Sued/Muenchen, Germany | Fax: +49-5121-206917-5555 | Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/ | _______________________________________________ barebox mailing list [email protected] http://lists.infradead.org/mailman/listinfo/barebox
Quoted 7 lines · Juergen Beisert
From: Juergen Beisert <[email protected]>
Subject: [PATCH] Add some help using the gpio commands at runtimeLast time I used the gpio commands I was somehow confused about the behaviour of the '
gpio_get_value' command. So, I decided to add some doc for it. Here's the result.
Quoted 6 lines
Signed-off-by Juergen Beisert <[email protected]>--- Documentation/commands.dox | 1 commands/gpio.c | 61+++++++++++++++++++++++++++++++++++++++++++++
Your mailer breaks lines. (Fixed while applying)
Sascha
Quoted 98 lines
2 files changed, 62 insertions(+)Index: barebox-2010.10.0/Documentation/commands.dox
===================================================================Documentation/commands.dox +1
-0@@ -10,6 +10,7 @@ @li @subpage edit_command @li @subpage erase_command @li @subpage export_command +@li @subpage gpio_for_users @li @subpage tftp_command @li @subpage loadenv_command @li @subpage mount_commandIndex:
barebox-2010.10.0/commands/gpio.c
===================================================================commands/gpio.c +60
-0@@ -120,3 +120,64 @@ BAREBOX_CMD_START(gpio_direction_output)BAREBOX_CMD_HELP (cmd_gpio_direction_output_help)BAREBOX_CMD_END +/** +@page gpio_for_users Runtime GPIO handling + +@section regular_gpio General usage information + +These commands are available if the symbol @b CONFIG_GENERIC_GPIO and +@b CONFIG_CMD_GPIO are enabled in the Kconfig. + +@note All gpio related commands take a number to identify the pad. This +number is architecture dependent. There may be no intuitional correlation +between available pads and the GPIO numbers to be used in the commands. Due +to this it's also possible the numbers change between @b barebox releases. + +@section gpio_dir_out Switch a pad into an output GPIO +@verbatim +gpio_direction_output <gpio_no> <initial_value> +@endverbatim +- @b gpio_no Architecture dependent GPIO number +- @b initial_value Output value the pad should emit + +@note To avoid glitches on the pad's line, the routines will first setting up +the pad's value and after that switching the pad itself to output (if the +silicon is able to do so) + +@note If the pad is already configured into a non GPIO mode (if available) +this command may fail (silently) + +@section gpio_dir_in Switch a pad into an input GPIO +@verbatim +gpio_direction_input <gpio_no> +@endverbatim +- @b gpio_no Architecture dependent GPIO number + +@note If the pad is already configured into a non GPIO mode (if available) +this command may fail (silently) + +@section gpio_get_value Read in the value of an GPIO input pad +@verbatim +gpio_get_value <gpio_no> +@endverbatim + +Reads in the current pad's line value from the given GPIO number. It returns +the value as a shell return code. There is no visible output at stdout. You +can check the return value by using "echo $?" + +@note If the return code is not '0' or '1' it's meant as an error code. + +@note If the pad is not configured for GPIO mode this command may fail +(silently) and returns garbage + +@section gpio_set_value Set a new value to a GPIO output pad +@verbatim +gpio_set_value <gpio_no> <value> +@endverbatim +- @b gpio_no Architecture dependent GPIO number +- @b value Output value the pad should emit + +Sets a new output @b value to the pad with GPIO number @b gpio_no + +@note If the pad is not configured for GPIO mode this command may fail (silently)
+*/Signature · 9 lines
Pengutronix e.K. | Juergen Beisert | Linux Solutions for Science and Industry | Phone: +49-8766-939 228 | Vertretung Sued/Muenchen, Germany | Fax: +49-5121-206917-5555 | Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/ | _______________________________________________ barebox mailing list [email protected] http://lists.infradead.org/mailman/listinfo/barebox
Signature · 9 lines
Pengutronix e.K. | | Industrial Linux Solutions | http://www.pengutronix.de/ | Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 | _______________________________________________ barebox mailing list [email protected] http://lists.infradead.org/mailman/listinfo/barebox