diff options
Diffstat (limited to 'c/src/lib/libbsp/i386/pc386/include/fb_vesa.h')
| -rw-r--r-- | c/src/lib/libbsp/i386/pc386/include/fb_vesa.h | 77 |
1 files changed, 39 insertions, 38 deletions
diff --git a/c/src/lib/libbsp/i386/pc386/include/fb_vesa.h b/c/src/lib/libbsp/i386/pc386/include/fb_vesa.h index b82d3e7cb8..d8bfd1bcb4 100644 --- a/c/src/lib/libbsp/i386/pc386/include/fb_vesa.h +++ b/c/src/lib/libbsp/i386/pc386/include/fb_vesa.h @@ -3,12 +3,10 @@ * * @ingroup i386_pc386 * - * @brief Definitioins for vesa based framebuffer drivers. + * @brief Headers specific for framebuffer drivers utilizing VESA VBE. */ /* - * Headers specific for framebuffer drivers utilizing VESA VBE. - * * Copyright (C) 2014 Jan Doležal (dolezj21@fel.cvut.cz) * CTU in Prague. * @@ -35,15 +33,16 @@ extern "C" { /* ----- Prototypes ----- */ /** - * Returns information about graphic's controller in the infoBlock structure. + * @brief Returns information about graphic's controller in the \p info_block + * structure. * - * @param infoBlock pointer to the struct to be filled with - controller information - * @param queriedVBEVersion if >0x200 then video bios is asked to fill in + * @param[out] info_block pointer to the struct to be filled with + * controller information + * @param[in] queried_VBE_Version if >0x200 then video bios is asked to fill in * parameters which appeared with second version * of VBE. - * @retval register ax content as defined in VBE RETURN STATUS paragraph - * -1 error calling graphical bios + * @retval ax register content as defined in VBE RETURN STATUS paragraph + * @retval -1 error calling graphical bios */ uint32_t VBE_controller_information ( VBE_vbe_info_block *info_block, @@ -51,13 +50,14 @@ uint32_t VBE_controller_information ( ); /** - * Fills structure infoBlock with informations about selected mode in - * modeNumber variable. + * @brief Fills structure \p info_block with informations about selected mode in + * \p mode_number variable. * - * @param infoBlock pointer to the struct to be filled with mode information - * @param modeNumber detailes of this mode to be filled - * @retval register ax content as defined in VBE RETURN STATUS paragraph - * -1 error calling graphical bios + * @param[out] info_block pointer to the struct to be filled with + * mode information + * @param[in] mode_number detailes of this mode to be filled + * @retval ax register content as defined in VBE RETURN STATUS paragraph + * @retval -1 error calling graphical bios */ uint32_t VBE_mode_information ( VBE_mode_info_block *info_block, @@ -65,13 +65,13 @@ uint32_t VBE_mode_information ( ); /** - * Sets graphics mode selected. If mode has refreshRateCtrl bit set, than the - * infoBlock must be filled accordingly. + * @brief Sets graphics mode selected. If mode has refreshRateCtrl bit set, than + * the \p info_block must be filled accordingly. * - * @param modeNumber number of mode to be set - * @param infoBlock pointer to struct containing refresh rate control info - * @retval register ax content as defined in VBE RETURN STATUS paragraph - * -1 error calling graphical bios + * @param[in] mode_number number of mode to be set + * @param[in] info_block pointer to struct containing refresh rate control info + * @retval ax register content as defined in VBE RETURN STATUS paragraph + * @retval -1 error calling graphical bios */ uint32_t VBE_set_mode ( uint16_t mode_number, @@ -79,27 +79,27 @@ uint32_t VBE_set_mode ( ); /** - * Get currently set mode number. + * @brief Get currently set mode number. * - * @param modeNumber variable to be filled with current mode number - * @retval register ax content as defined in VBE RETURN STATUS paragraph - * -1 error calling graphical bios + * @param[out] mode_number variable to be filled with current mode number + * @retval ax register content as defined in VBE RETURN STATUS paragraph + * @retval -1 error calling graphical bios */ uint32_t VBE_current_mode ( uint16_t *mode_number ); /** - * Gets information about display data channel implemented in the + * @brief Gets information about display data channel implemented in the * graphic's controller. * - * @param controllerUnitNumber - * @param secondsToTransferEDIDBlock approximate time to transfer one EDID block - * rounded up to seconds - * @param DDCLevelSupported after call contains DDC version supported and + * @param[in] controller_unit_number + * @param[out] seconds_to_transfer_EDID_block approximate time to transfer one + * EDID block rounded up to seconds + * @param[out] DDC_level_supported contains DDC version supported and * screen blanking state during transfer - * @retval register ax content as defined in VBE RETURN STATUS paragraph - * -1 error calling graphical bios + * @retval ax register content as defined in VBE RETURN STATUS paragraph + * @retval -1 error calling graphical bios */ uint32_t VBE_report_DDC_capabilities ( uint16_t controller_unit_number, @@ -108,13 +108,14 @@ uint32_t VBE_report_DDC_capabilities ( ); /** - * Reads selected EDID block from display attached to controller's interface. + * @brief Reads selected EDID block from display attached to controller's + * interface. * - * @param controllerUnitNumber - * @param EDIDBlockNumber block no. to be read from the display - * @param buffer place to store block fetched from the display - * @retval register ax content as defined in VBE RETURN STATUS paragraph - * -1 error calling graphical bios + * @param[in] controller_unit_number + * @param[in] EDID_block_number block no. to be read from the display + * @param[out] buffer place to store block fetched from the display + * @retval ax register content as defined in VBE RETURN STATUS paragraph + * @retval -1 error calling graphical bios */ uint32_t VBE_read_EDID ( uint16_t controller_unit_number, |