diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2014-11-29 07:08:30 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2014-11-29 07:08:30 -0600 |
commit | 7773304d911066ca3345eb295a944d949fd220c4 (patch) | |
tree | eb35b65bd0989cb405117ac6460f16fc19d186dd /nuttx/include | |
parent | 589e38f3025d6db15dfe3a266691070d6bf74368 (diff) | |
download | nuttx-7773304d911066ca3345eb295a944d949fd220c4.tar.gz nuttx-7773304d911066ca3345eb295a944d949fd220c4.tar.bz2 nuttx-7773304d911066ca3345eb295a944d949fd220c4.zip |
Update/correct some comments
Diffstat (limited to 'nuttx/include')
-rw-r--r-- | nuttx/include/nuttx/input/ajoystick.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/nuttx/include/nuttx/input/ajoystick.h b/nuttx/include/nuttx/input/ajoystick.h index 3537f15f1..12f8ae406 100644 --- a/nuttx/include/nuttx/input/ajoystick.h +++ b/nuttx/include/nuttx/input/ajoystick.h @@ -35,8 +35,9 @@ /* This header file provides definition for a standard analog joystick * interface. An analog joystick refers to a joystick that provides X/Y - * positional data as integer values such as might be provides by DACs. - * The analog positional data may be accompanied by discrete button data. + * positional data as integer values such as might be provides by Analog- + * to-Digital Conversion (ADC). The analog positional data may also be + * accompanied by discrete button data. * * The analog joystick driver exports a standard character driver * interface. By convention, the analog joystick is registered as an input @@ -109,7 +110,9 @@ * * 1) The read() method will always return a single value of size * struct ajoy_sample_s represent the current joystick positional and the - * state of all joystick buttons. read() never blocks. + * state of all joystick buttons. read() never blocks. X an Y position + * data is raw converted data. Zeroing and scaling must be performed by + * the application. * 2) The poll() method can be used to notify a client if there is a change * in any of the joystick button inputs. This feature, of course, * depends upon interrupt GPIO support from the platform. NOTE: that |