git: b3b15d9256cb - main - cam: Add doxygen for cam_sim_free
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 05 Oct 2021 13:08:25 UTC
The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=b3b15d9256cbba94d509d1c8b1c5b2379f03fd26 commit b3b15d9256cbba94d509d1c8b1c5b2379f03fd26 Author: Warner Losh <imp@FreeBSD.org> AuthorDate: 2021-10-05 13:07:17 +0000 Commit: Warner Losh <imp@FreeBSD.org> CommitDate: 2021-10-05 13:07:47 +0000 cam: Add doxygen for cam_sim_free Sponsored by: Netflix Reviewed by: mav Differential Revision: https://reviews.freebsd.org/D32303 --- sys/cam/cam_sim.c | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/sys/cam/cam_sim.c b/sys/cam/cam_sim.c index e7a7348d0c44..abf65965fc8e 100644 --- a/sys/cam/cam_sim.c +++ b/sys/cam/cam_sim.c @@ -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) {