diff options
| author | Landon J. Fuller <landonf@FreeBSD.org> | 2017-11-27 21:30:49 +0000 |
|---|---|---|
| committer | Landon J. Fuller <landonf@FreeBSD.org> | 2017-11-27 21:30:49 +0000 |
| commit | 05ed3f9063415c85e3d15f11904bac28e285e9f9 (patch) | |
| tree | 56460c452d541fda08c5ff31499744cf8ca1711f /sys/dev/bhnd/bhnd.h | |
| parent | 18e980c0e05ef128446723f7fc96e8dc864df088 (diff) | |
| download | src-05ed3f9063415c85e3d15f11904bac28e285e9f9.tar.gz src-05ed3f9063415c85e3d15f11904bac28e285e9f9.zip | |
bhnd(4) update inline documentation comments and man pages.
This includes a number of copyedits for the inline code documentation
comments, updates to the existing bhnd(4), bhndb(4), bcma(4), and siba(4)
man pages, and new man pages for bhnd_chipc(4), bhnd_pmu(4), bhndb_pci(4),
bhnd(9), and bhnd_erom(9).
Approved by: adrian (mentor)
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D13021
Notes
Notes:
svn path=/head/; revision=326291
Diffstat (limited to 'sys/dev/bhnd/bhnd.h')
| -rw-r--r-- | sys/dev/bhnd/bhnd.h | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/sys/dev/bhnd/bhnd.h b/sys/dev/bhnd/bhnd.h index 96e8e93a6a24..9ae6e5e0ecef 100644 --- a/sys/dev/bhnd/bhnd.h +++ b/sys/dev/bhnd/bhnd.h @@ -270,7 +270,7 @@ struct bhnd_dma_translation { bhnd_addr_t addrext_mask; /** - * Translation flags (see bhnd_dma_translation_flags) + * Translation flags (see bhnd_dma_translation_flags). */ uint32_t flags; }; @@ -909,8 +909,7 @@ bhnd_get_dma_translation(device_t dev, u_int width, uint32_t flags, * This relies on NVRAM access, and will fail if a valid NVRAM device cannot * be found, or is not yet attached. * - * @param dev The parent of @p child. - * @param child The bhnd device requesting board info. + * @param dev The bhnd device requesting board info. * @param[out] info On success, will be populated with the bhnd(4) device's * board information. * @@ -986,8 +985,7 @@ bhnd_map_intr(device_t dev, u_int intr, rman_res_t *irq) * Unmap an bus interrupt previously mapped via bhnd_map_intr(). * * @param dev The requesting device. - * @param intr The interrupt number being unmapped. This is equivalent to the - * bus resource ID for the interrupt. + * @param irq The interrupt value being unmapped. */ static inline void bhnd_unmap_intr(device_t dev, rman_res_t irq) @@ -1374,15 +1372,15 @@ bhnd_release_resource(device_t dev, int type, int rid, * * @param dev A bhnd bus child device. * @param type The port type being queried. - * @param port_num The port number being queried. - * @param region_num The region number being queried. + * @param port The port number being queried. + * @param region The region number being queried. */ static inline bool -bhnd_is_region_valid(device_t dev, bhnd_port_type type, u_int port_num, - u_int region_num) +bhnd_is_region_valid(device_t dev, bhnd_port_type type, u_int port, + u_int region) { return (BHND_BUS_IS_REGION_VALID(device_get_parent(dev), dev, type, - port_num, region_num)); + port, region)); } /** |