diff options
Diffstat (limited to 'arch/x86/include/asm/fsp/fsp_support.h')
-rw-r--r-- | arch/x86/include/asm/fsp/fsp_support.h | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/arch/x86/include/asm/fsp/fsp_support.h b/arch/x86/include/asm/fsp/fsp_support.h index 3cd3e4f..68331eb 100644 --- a/arch/x86/include/asm/fsp/fsp_support.h +++ b/arch/x86/include/asm/fsp/fsp_support.h @@ -23,7 +23,7 @@ /** * fsp_find_header() - Find FSP header offset in FSP image * - * @return the offset of FSP header. If signature is invalid, returns 0. + * Return: the offset of FSP header. If signature is invalid, returns 0. */ struct fsp_header *fsp_find_header(void); @@ -33,7 +33,7 @@ struct fsp_header *fsp_find_header(void); * @fsp_hdr: Pointer to FSP information header * @phase: FSP initialization phase defined in enum fsp_phase * - * @return compatible status code with EFI_STATUS defined in PI spec + * Return: compatible status code with EFI_STATUS defined in PI spec */ u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase); @@ -42,7 +42,7 @@ u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase); * * @hob_list: A HOB list pointer. * - * @return Usable low memory top. + * Return: Usable low memory top. */ u32 fsp_get_usable_lowmem_top(const void *hob_list); @@ -51,7 +51,7 @@ u32 fsp_get_usable_lowmem_top(const void *hob_list); * * @hob_list: A HOB list pointer. * - * @return Usable high memory top. + * Return: Usable high memory top. */ u64 fsp_get_usable_highmem_top(const void *hob_list); @@ -63,7 +63,7 @@ u64 fsp_get_usable_highmem_top(const void *hob_list); * If the GUID HOB is located, the length will be updated. * @guid: A pointer to the owner guild. * - * @return Reserved region start address. + * Return: Reserved region start address. * 0 if this region does not exist. */ u64 fsp_get_reserved_mem_from_guid(const void *hob_list, @@ -75,7 +75,7 @@ u64 fsp_get_reserved_mem_from_guid(const void *hob_list, * @hob_list: A HOB list pointer. * @len: A pointer to the FSP reserved memory length buffer. * If the GUID HOB is located, the length will be updated. - * @return FSP reserved memory base + * Return: FSP reserved memory base * 0 if this region does not exist. */ u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len); @@ -87,8 +87,8 @@ u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len); * @len: A pointer to the TSEG reserved memory length buffer. * If the GUID HOB is located, the length will be updated. * - * @return NULL: Failed to find the TSEG reserved memory. - * @return others: TSEG reserved memory base. + * Return: NULL: Failed to find the TSEG reserved memory. + * Return: others: TSEG reserved memory base. */ u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len); @@ -99,8 +99,8 @@ u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len); * @len: A pointer to the NVS data buffer length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the NVS HOB. - * @return others: FSP NVS data buffer pointer. + * Return: NULL: Failed to find the NVS HOB. + * Return: others: FSP NVS data buffer pointer. */ void *fsp_get_nvs_data(const void *hob_list, u32 *len); @@ -111,8 +111,8 @@ void *fsp_get_nvs_data(const void *hob_list, u32 *len); * @len: A pointer to the NVS data buffer length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the NVS HOB. - * @return others: FSP NVS data buffer pointer. + * Return: NULL: Failed to find the NVS HOB. + * Return: others: FSP NVS data buffer pointer. */ void *fsp_get_var_nvs_data(const void *hob_list, u32 *len); @@ -123,15 +123,15 @@ void *fsp_get_var_nvs_data(const void *hob_list, u32 *len); * @len: A pointer to the graphics info HOB length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the graphics info HOB. - * @return others: A pointer to struct hob_graphics_info. + * Return: NULL: Failed to find the graphics info HOB. + * Return: others: A pointer to struct hob_graphics_info. */ void *fsp_get_graphics_info(const void *hob_list, u32 *len); /** * fsp_init_phase_pci() - Tell the FSP that we have completed PCI init * - * @return 0 if OK, -EPERM if the FSP gave an error. + * Return: 0 if OK, -EPERM if the FSP gave an error. */ int fsp_init_phase_pci(void); @@ -140,7 +140,7 @@ int fsp_init_phase_pci(void); * * This sets gd->ram_size based on what it finds. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsp_scan_for_ram_size(void); @@ -150,7 +150,7 @@ int fsp_scan_for_ram_size(void); * @fsp_hdr: Pointer to FSP information header * @phase: FSP initialization phase defined in enum fsp_phase * - * @return compatible status code with EFI_STATUS defined in PI spec + * Return: compatible status code with EFI_STATUS defined in PI spec */ u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase); |