.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "mlx5dv_devx_subscribe_devx_event, mlx5dv_devx_subscribe_devx_event_fd" "3" "" "" ""
.hy
.SH NAME
.PP
mlx5dv_devx_subscribe_devx_event \- Subscribe over an event channel for
device events.
.PP
mlx5dv_devx_subscribe_devx_event_fd \- Subscribe over an event channel
for device events to signal eventfd.
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <infiniband/mlx5dv.h>

int\ mlx5dv_devx_subscribe_devx_event(struct\ mlx5dv_devx_event_channel\ *dv_event_channel,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ struct\ mlx5dv_devx_obj\ *obj,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ uint16_t\ events_sz,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ uint16_t\ events_num[],
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ uint64_t\ cookie)

int\ mlx5dv_devx_subscribe_devx_event_fd(struct\ mlx5dv_devx_event_channel\ *dv_event_channel,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ int\ fd,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ struct\ mlx5dv_devx_obj\ *obj,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ uint16_t\ event_num)
\f[]
.fi
.SH DESCRIPTION
.PP
Subscribe over a DEVX event channel for device events.
.SH ARGUMENTS
.TP
.B \f[I]dv_event_channel\f[]
Event channel to subscribe over.
.RS
.RE
.TP
.B \f[I]fd\f[]
A file descriptor that previously was opened by the eventfd() system
call.
.RS
.RE
.TP
.B \f[I]obj\f[]
DEVX object that \f[I]events_num\f[] relates to, can be NULL for
unaffiliated events.
.RS
.RE
.TP
.B \f[I]events_sz\f[]
Size of the \f[I]events_num\f[] buffer that holds the events to
subscribe for.
.RS
.RE
.TP
.B \f[I]events_num\f[]
Holds the required event numbers to subscribe for, numbers are according
to the device specification.
.RS
.RE
.TP
.B \f[I]cookie\f[]
The value to be returned back when reading the event, can be used as an
ID for application use.
.RS
.RE
.SH NOTES
.PP
When mlx5dv_devx_subscribe_devx_event_fd will be used the \f[I]fd\f[]
will be signaled once an event has occurred.
.SH SEE ALSO
.PP
\f[I]mlx5dv_open_device(3)\f[],
\f[I]mlx5dv_devx_create_event_channel(3)\f[],
\f[I]mlx5dv_devx_get_event(3)\f[]
.SH AUTHOR
.PP
Yishai Hadas <yishaih@mellanox.com>
