cam_sim: add doxygen to cam_sim_alloc_dev

cam_sim_alloc_dev was overlooked when cam_sim_alloc was documented.
Add doxygen docs for it, pointing at cam_sim_alloc.

Sponsored by:		Netflix
This commit is contained in:
Warner Losh 2021-05-16 09:37:26 -06:00
parent c28cb257dd
commit 96480d9b33

View File

@ -130,11 +130,19 @@ cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
return (sim);
}
/**
* @brief allocate a new sim and fill in the details with a device_t
*
* Just like @c cam_sim_alloc, but with an additional paramter.
*
* @param dev A newbus device that's associated with the
* sim. Must be non-NULL.
*/
struct cam_sim *
cam_sim_alloc_dev(sim_action_func sim_action, sim_poll_func sim_poll,
const char *sim_name, void *softc, device_t dev,
struct mtx *mtx, int max_dev_transactions,
int max_tagged_dev_transactions, struct cam_devq *queue)
const char *sim_name, void *softc, device_t dev, struct mtx *mtx,
int max_dev_transactions, int max_tagged_dev_transactions,
struct cam_devq *queue)
{
struct cam_sim *sim;