cam: Add doxygen for cam_sim_free

Sponsored by:		Netflix
Reviewed by:		mav
Differential Revision:	https://reviews.freebsd.org/D32303
This commit is contained in:
Warner Losh 2021-10-05 07:07:17 -06:00
parent cee9a741b2
commit b3b15d9256

View File

@ -127,6 +127,19 @@ cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
return (sim);
}
/**
* @brief frees up the sim
*
* Frees up the CAM @c sim and optionally the devq. If a mutex is associated
* with the sim, it must be locked on entry. It will remain locked on
* return.
*
* This function will wait for all outstanding reference to the sim to clear
* before returning.
*
* @param sim The sim to free
* @param free_devq Free the devq associated with the sim at creation.
*/
void
cam_sim_free(struct cam_sim *sim, int free_devq)
{