sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

include/nuttx/input/djoystick.h: Fix some trivial typos and nxstyle

Browse Source 
issues.
This commit is contained in:
Ouss4 2020-06-10 21:35:16 +01:00 committed by patacongo
parent 72ff383265
commit fe7dfec37d
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
include/nuttx/input/djoystick.h
View File

@ -63,6 +63,7 @@
/**************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
****************************************************************************/ ****************************************************************************/
/* Configuration ************************************************************/ /* Configuration ************************************************************/
#ifndef CONFIG_DJOYSTICK_NPOLLWAITERS #ifndef CONFIG_DJOYSTICK_NPOLLWAITERS
@ -70,6 +71,7 @@
#endif #endif
/* Joystick Interface *******************************************************/ /* Joystick Interface *******************************************************/
/* These definitions provide the meaning of all of the bits that may be /* These definitions provide the meaning of all of the bits that may be
* reported in the djoy_buttonset_t bitset. * reported in the djoy_buttonset_t bitset.
*/ */
@ -114,8 +116,8 @@
* seek() methods. The remaining driver methods behave as follows: * seek() methods. The remaining driver methods behave as follows:
* *
* 1) The read() method will always return a single value of size * 1) The read() method will always return a single value of size
* djoy_buttonset_t represent the current state of the joystick buttons. * djoy_buttonset_t that represents the current state of the joystick
* read() never blocks. * buttons. read() never blocks.
* 2) The poll() method can be used to notify a client if there is a change * 2) The poll() method can be used to notify a client if there is a change
* in any of the joystick discrete inputs. This feature, of course, * in any of the joystick discrete inputs. This feature, of course,
* depends upon interrupt GPIO support from the platform. NOTE: that * depends upon interrupt GPIO support from the platform. NOTE: that
@ -140,7 +142,8 @@
* Description: Specify the set of button events that can cause a poll() * Description: Specify the set of button events that can cause a poll()
* to awaken. The default is all button depressions and all * to awaken. The default is all button depressions and all
* button releases (all supported buttons); * button releases (all supported buttons);
* Argument: A read-only pointer to an instance of struct djoy_pollevents_s * Argument: A read-only pointer to an instance of struct
* djoy_pollevents_s
* Return: Zero (OK) on success. Minus one will be returned on failure * Return: Zero (OK) on success. Minus one will be returned on failure
* with the errno value set appropriately. * with the errno value set appropriately.
*/ */
@ -162,15 +165,16 @@
/**************************************************************************** /****************************************************************************
* Public Types * Public Types
****************************************************************************/ ****************************************************************************/
/* This type is a bit set that contains the state of all discrete joystick /* This type is a bit set that contains the state of all discrete joystick
* buttons. * buttons.
*/ */
typedef uint8_t djoy_buttonset_t; typedef uint8_t djoy_buttonset_t;
/* A reference to this structure is provided with the DJOYIOC_POLLEVENTS IOCTL /* A reference to this structure is provided with the DJOYIOC_POLLEVENTS
* command and describes the conditions under which the client would like * IOCTL command and describes the conditions under which the client would
* to receive notification. * like to receive notification.
*/ */
struct djoy_pollevents_s struct djoy_pollevents_s
@ -216,13 +220,15 @@ struct djoy_lowerhalf_s
{ {
/* Return the set of buttons supported on the discrete joystick device */ /* Return the set of buttons supported on the discrete joystick device */
CODE djoy_buttonset_t (*dl_supported)(FAR const struct djoy_lowerhalf_s *lower); CODE djoy_buttonset_t (*dl_supported)
(FAR const struct djoy_lowerhalf_s *lower);
/* Return the current state of all discrete joystick buttons */ /* Return the current state of all discrete joystick buttons */
CODE djoy_buttonset_t (*dl_sample)(FAR const struct djoy_lowerhalf_s *lower); CODE djoy_buttonset_t (*dl_sample)
(FAR const struct djoy_lowerhalf_s *lower);
/* Enable interrupts on the selected set of joystick buttons. And empty /* Enable interrupts on the selected set of joystick buttons. An empty
* set will disable all interrupts. * set will disable all interrupts.
*/ */