e10k: enabling requesting default queue
[barrelfish] / include / devif / backends / net / e10k_devif.h
index fd228e9..3119d2f 100644 (file)
 struct e10k_queue;
 typedef void (*e10k_event_cb_t)(void* q);
 
+
+/**
+* @brief create a handle to a queue of an e10k card. Assumes the driver is
+*        running
+*
+* @param q             Return pointer to the device queue
+* @param cb            Callback function when an interrupt is raised
+* @param use_vf        Start virtual functions, otherwise the physical function
+*                      will be used
+* @param interrupts    Use interrupts, otherwise polling
+* @param default_q     Request a handle to the default queue where
+*                      all the not filtered packes go to. Mostly use when
+*                      a queue is request from the driver itself.
+*
+* @returns error on NIC_ERR_ALLOC or SYS_ERR_OK on success
+*
+*/
 errval_t e10k_queue_create(struct e10k_queue** q, e10k_event_cb_t cb, 
-                           bool use_vf, bool interrupts);
+                           bool use_vf, bool interrupts, bool default_q);
 errval_t e10k_queue_destroy(struct e10k_queue* q);
 
+
+/**
+* @brief get the queue id of this queue handle. The returned id corresponds
+*        to the real id used on the card
+*
+* @param q             handl to the device queue
+*
+* @returns the queues id
+*
+*/
 uint64_t e10k_queue_get_id(struct e10k_queue* q);
 #endif