diff --git a/doc/libdevq.3 b/doc/libdevq.3 index 070e792..af302aa 100644 --- a/doc/libdevq.3 +++ b/doc/libdevq.3 @@ -104,8 +104,6 @@ Portable query and monitoring library (libdevq, -ldevq) .Fo devq_event_monitor_read .Fa "struct devq_evmon *" .Fc -.Sh DESCRIPTION -Let's describe here .Sh REFERENCE This section documents the functions, types, and variable available via .In libdevq.h . @@ -155,11 +153,53 @@ An opaque structure representing an event An opaque structure representing an event monitor .El .Ss Functions +Device query functions. +.Pp +Most of these functions will return a integer to indicate the status, 0 for success and -1 for failure. On success the spullied variables in the function call will hold the results. .Bl -ohang .It Fn devq_device_get_class -Return the device class for a given +Return the device class for a given +.It Fn devq_device_get_devpath_from_fd +Fill the supplied path and path_len variables with the devpath. Return 0 on success and -1 on failure +.It Fn devq_device_get_path + +.It Fn devq_device_get_pciid_from_fd +Fill the supplied vendor_id and device_id variable of the specified device by the fd. Return 0 on success and -1 on failure. +.It Fn devq_device_get_product +fillme +.It Fn devq_device_get_type +fillme +.It Fn devq_device_get_vendor +fillme +.It Fn devq_drm_get_drvname_from_fd + +Return 0 on success and -1 on failure. +.Pp +Device notification API +.It Fn devq_event_dump +fillme +.It Fn devq_event_free +fillme +.It Fn devq_event_get_deviced +function bla +.It Fn devq_event_get_type +function returns The DEVQ event type. +.It Fn devq_event_monitor_init +function setups the monitoring code. +.It Fn devq_event_monitor_fini +function cleanup the event monitering code. +.It Fn devq_event_monitor_get_fd +function returns fd or -1 if monitoring hasn't been initilized. +.It Fn devq_event_monitor_poll +function polls if there are any events waiting +.It Fn devq_event_monitor_read +function read new events from the poll fucntion. .Va device . .El +.Sh Return values +Do we return error values apart from 0 and -1? +.Sh Examples +fill me... .Sh SEE ALSO .Xr devinfo 3 , .Xr devctl 4 ,