mirror of https://github.com/ericonr/sndio.git
Document sioctl_desc structure maxval attribute
This commit is contained in:
parent
0c3fd96693
commit
41b654cfe7
|
@ -123,7 +123,7 @@ struct sioctl_node {
|
||||||
struct sioctl_desc {
|
struct sioctl_desc {
|
||||||
unsigned int addr; /* control address */
|
unsigned int addr; /* control address */
|
||||||
#define SIOCTL_NONE 0 /* deleted */
|
#define SIOCTL_NONE 0 /* deleted */
|
||||||
#define SIOCTL_NUM 2 /* integer in the 0..127 range */
|
#define SIOCTL_NUM 2 /* integer in the maxval range */
|
||||||
#define SIOCTL_SW 3 /* on/off switch (0 or 1) */
|
#define SIOCTL_SW 3 /* on/off switch (0 or 1) */
|
||||||
#define SIOCTL_VEC 4 /* number, element of vector */
|
#define SIOCTL_VEC 4 /* number, element of vector */
|
||||||
#define SIOCTL_LIST 5 /* switch, element of a list */
|
#define SIOCTL_LIST 5 /* switch, element of a list */
|
||||||
|
@ -132,6 +132,7 @@ struct sioctl_desc {
|
||||||
char group[SIOCTL_NAMEMAX]; /* group this control belongs to */
|
char group[SIOCTL_NAMEMAX]; /* group this control belongs to */
|
||||||
struct sioctl_node node0; /* affected node */
|
struct sioctl_node node0; /* affected node */
|
||||||
struct sioctl_node node1; /* dito for SIOCTL_{VEC,LIST} */
|
struct sioctl_node node1; /* dito for SIOCTL_{VEC,LIST} */
|
||||||
|
unsigned int maxval; /* max value */
|
||||||
};
|
};
|
||||||
.Ed
|
.Ed
|
||||||
.Pp
|
.Pp
|
||||||
|
@ -149,7 +150,11 @@ Possible types are:
|
||||||
.It SIOCTL_NONE
|
.It SIOCTL_NONE
|
||||||
A previously valid control was deleted.
|
A previously valid control was deleted.
|
||||||
.It SIOCTL_NUM
|
.It SIOCTL_NUM
|
||||||
A continuous control in the 0..SIOCTL_VALMAX range.
|
A continuous control in the
|
||||||
|
.Sm 0 ..
|
||||||
|
.Va maxval
|
||||||
|
.Sm
|
||||||
|
range.
|
||||||
For instance the volume of the speaker.
|
For instance the volume of the speaker.
|
||||||
.It SIOCTL_SW
|
.It SIOCTL_SW
|
||||||
A on/off switch control.
|
A on/off switch control.
|
||||||
|
@ -190,6 +195,11 @@ attributes and
|
||||||
.Va func
|
.Va func
|
||||||
are strings usable as unique identifiers within the the given
|
are strings usable as unique identifiers within the the given
|
||||||
.Va group .
|
.Va group .
|
||||||
|
.Pp
|
||||||
|
The
|
||||||
|
.Va maxval
|
||||||
|
attribute indicates the maximum value of this control.
|
||||||
|
For boolean control types it is set to 1.
|
||||||
.Sh Changing and reading control values
|
.Sh Changing and reading control values
|
||||||
Controls are changed with the
|
Controls are changed with the
|
||||||
.Fn sioctl_setval
|
.Fn sioctl_setval
|
||||||
|
@ -198,7 +208,11 @@ The
|
||||||
.Fn sioctl_onval
|
.Fn sioctl_onval
|
||||||
function can be used to register a call-back which will be invoked whenever
|
function can be used to register a call-back which will be invoked whenever
|
||||||
a control changes.
|
a control changes.
|
||||||
Continuous values are in the 0..127 range.
|
Continuous values are in the
|
||||||
|
.Sm 0 ..
|
||||||
|
.Va maxval
|
||||||
|
.Sm
|
||||||
|
range.
|
||||||
.Sh "Interface to" Xr poll 2
|
.Sh "Interface to" Xr poll 2
|
||||||
The
|
The
|
||||||
.Fn sioctl_pollfd
|
.Fn sioctl_pollfd
|
||||||
|
|
|
@ -104,7 +104,7 @@ struct sioctl_node {
|
||||||
struct sioctl_desc {
|
struct sioctl_desc {
|
||||||
unsigned int addr; /* control address */
|
unsigned int addr; /* control address */
|
||||||
#define SIOCTL_NONE 0 /* deleted */
|
#define SIOCTL_NONE 0 /* deleted */
|
||||||
#define SIOCTL_NUM 2 /* integer in the 0..127 range */
|
#define SIOCTL_NUM 2 /* integer in the 0..maxval range */
|
||||||
#define SIOCTL_SW 3 /* on/off switch (0 or 1) */
|
#define SIOCTL_SW 3 /* on/off switch (0 or 1) */
|
||||||
#define SIOCTL_VEC 4 /* number, element of vector */
|
#define SIOCTL_VEC 4 /* number, element of vector */
|
||||||
#define SIOCTL_LIST 5 /* switch, element of a list */
|
#define SIOCTL_LIST 5 /* switch, element of a list */
|
||||||
|
@ -113,7 +113,7 @@ struct sioctl_desc {
|
||||||
char group[SIOCTL_NAMEMAX]; /* group this control belongs to */
|
char group[SIOCTL_NAMEMAX]; /* group this control belongs to */
|
||||||
struct sioctl_node node0; /* affected node */
|
struct sioctl_node node0; /* affected node */
|
||||||
struct sioctl_node node1; /* dito for SIOCTL_{VEC,LIST} */
|
struct sioctl_node node1; /* dito for SIOCTL_{VEC,LIST} */
|
||||||
unsigned int maxval; /* max value for SIOCTL_{NUM,VEC} */
|
unsigned int maxval; /* max value */
|
||||||
int __pad[3];
|
int __pad[3];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue