Skip to content

Commit 4275852

Browse files
committed
parisc: firmware: Fix kdoc warnings
Signed-off-by: Helge Deller <deller@gmx.de>
1 parent ac9fb7d commit 4275852

1 file changed

Lines changed: 21 additions & 18 deletions

File tree

arch/parisc/kernel/firmware.c

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ static unsigned long f_extend(unsigned long address)
134134

135135
/**
136136
* convert_to_wide - Convert the return buffer addresses into kernel addresses.
137-
* @address: The return buffer from PDC.
137+
* @addr: The return buffer from PDC.
138138
*
139139
* This function is used to convert the return buffer addresses retrieved from PDC
140140
* into kernel addresses when the PDC address size and kernel address size are
@@ -160,6 +160,8 @@ void set_firmware_width_unlocked(void)
160160

161161
ret = mem_pdc_call(PDC_MODEL, PDC_MODEL_CAPABILITIES,
162162
__pa(pdc_result), 0);
163+
if (ret < 0)
164+
return;
163165
convert_to_wide(pdc_result);
164166
if (pdc_result[0] != NARROW_FIRMWARE)
165167
parisc_narrow_firmware = 0;
@@ -255,8 +257,8 @@ int __init pdc_instr(unsigned int *instr)
255257

256258
/**
257259
* pdc_chassis_info - Return chassis information.
258-
* @result: The return buffer.
259260
* @chassis_info: The memory buffer address.
261+
* @led_info: The size of the memory buffer address.
260262
* @len: The size of the memory buffer address.
261263
*
262264
* An HVERSION dependent call for returning the chassis information.
@@ -280,7 +282,8 @@ int __init pdc_chassis_info(struct pdc_chassis_info *chassis_info, void *led_inf
280282

281283
/**
282284
* pdc_pat_chassis_send_log - Sends a PDC PAT CHASSIS log message.
283-
* @retval: -1 on error, 0 on success. Other value are PDC errors
285+
* @state: state of the machine
286+
* @data: value for that state
284287
*
285288
* Must be correctly formatted or expect system crash
286289
*/
@@ -303,7 +306,7 @@ int pdc_pat_chassis_send_log(unsigned long state, unsigned long data)
303306

304307
/**
305308
* pdc_chassis_disp - Updates chassis code
306-
* @retval: -1 on error, 0 on success
309+
* @disp: value to show on display
307310
*/
308311
int pdc_chassis_disp(unsigned long disp)
309312
{
@@ -318,8 +321,7 @@ int pdc_chassis_disp(unsigned long disp)
318321
}
319322

320323
/**
321-
* pdc_cpu_rendenzvous - Stop currently executing CPU
322-
* @retval: -1 on error, 0 on success
324+
* __pdc_cpu_rendezvous - Stop currently executing CPU and do not return.
323325
*/
324326
int __pdc_cpu_rendezvous(void)
325327
{
@@ -347,7 +349,7 @@ void pdc_cpu_rendezvous_unlock(void)
347349

348350
/**
349351
* pdc_pat_get_PDC_entrypoint - Get PDC entry point for current CPU
350-
* @retval: -1 on error, 0 on success
352+
* @pdc_entry: pointer to where the PDC entry point should be stored
351353
*/
352354
int pdc_pat_get_PDC_entrypoint(unsigned long *pdc_entry)
353355
{
@@ -369,7 +371,7 @@ int pdc_pat_get_PDC_entrypoint(unsigned long *pdc_entry)
369371
}
370372
/**
371373
* pdc_chassis_warn - Fetches chassis warnings
372-
* @retval: -1 on error, 0 on success
374+
* @warn: The warning value to be shown
373375
*/
374376
int pdc_chassis_warn(unsigned long *warn)
375377
{
@@ -521,6 +523,7 @@ int pdc_model_info(struct pdc_model *model)
521523

522524
/**
523525
* pdc_model_sysmodel - Get the system model name.
526+
* @os_id: The operating system ID asked for (an OS_ID_* value)
524527
* @name: A char array of at least 81 characters.
525528
*
526529
* Get system model name from PDC ROM (e.g. 9000/715 or 9000/778/B160L).
@@ -549,7 +552,7 @@ int pdc_model_sysmodel(unsigned int os_id, char *name)
549552

550553
/**
551554
* pdc_model_versions - Identify the version number of each processor.
552-
* @cpu_id: The return buffer.
555+
* @versions: The return buffer.
553556
* @id: The id of the processor to check.
554557
*
555558
* Returns the version number for each processor component.
@@ -996,8 +999,8 @@ int pdc_pci_irt(unsigned long num_entries, unsigned long hpa, void *tbl)
996999

9971000
/**
9981001
* pdc_pci_config_read - read PCI config space.
999-
* @hpa token from PDC to indicate which PCI device
1000-
* @pci_addr configuration space address to read from
1002+
* @hpa: Token from PDC to indicate which PCI device
1003+
* @cfg_addr: Configuration space address to read from
10011004
*
10021005
* Read PCI Configuration space *before* linux PCI subsystem is running.
10031006
*/
@@ -1019,9 +1022,9 @@ unsigned int pdc_pci_config_read(void *hpa, unsigned long cfg_addr)
10191022

10201023
/**
10211024
* pdc_pci_config_write - read PCI config space.
1022-
* @hpa token from PDC to indicate which PCI device
1023-
* @pci_addr configuration space address to write
1024-
* @val value we want in the 32-bit register
1025+
* @hpa: Token from PDC to indicate which PCI device
1026+
* @cfg_addr: Configuration space address to write
1027+
* @val: Value we want in the 32-bit register
10251028
*
10261029
* Write PCI Configuration space *before* linux PCI subsystem is running.
10271030
*/
@@ -1557,7 +1560,7 @@ int pdc_pat_get_irt(void *r_addr, unsigned long cell_num)
15571560

15581561
/**
15591562
* pdc_pat_pd_get_addr_map - Retrieve information about memory address ranges.
1560-
* @actlen: The return buffer.
1563+
* @actual_len: The return buffer.
15611564
* @mem_addr: Pointer to the memory buffer.
15621565
* @count: The number of bytes to read from the buffer.
15631566
* @offset: The offset with respect to the beginning of the buffer.
@@ -1580,7 +1583,7 @@ int pdc_pat_pd_get_addr_map(unsigned long *actual_len, void *mem_addr,
15801583
}
15811584

15821585
/**
1583-
* pdc_pat_pd_get_PDC_interface_revisions - Retrieve PDC interface revisions.
1586+
* pdc_pat_pd_get_pdc_revisions - Retrieve PDC interface revisions.
15841587
* @legacy_rev: The legacy revision.
15851588
* @pat_rev: The PAT revision.
15861589
* @pdc_cap: The PDC capabilities.
@@ -1635,7 +1638,7 @@ int pdc_pat_io_pci_cfg_read(unsigned long pci_addr, int pci_size, u32 *mem_addr)
16351638
* pdc_pat_io_pci_cfg_write - Retrieve information about memory address ranges.
16361639
* @pci_addr: PCI configuration space address for which the write request is being made.
16371640
* @pci_size: Size of write in bytes. Valid values are 1, 2, and 4.
1638-
* @value: Pointer to 1, 2, or 4 byte value in low order end of argument to be
1641+
* @val: Pointer to 1, 2, or 4 byte value in low order end of argument to be
16391642
* written to PCI Config space.
16401643
*
16411644
*/
@@ -1653,7 +1656,7 @@ int pdc_pat_io_pci_cfg_write(unsigned long pci_addr, int pci_size, u32 val)
16531656
}
16541657

16551658
/**
1656-
* pdc_pat_mem_pdc_info - Retrieve information about page deallocation table
1659+
* pdc_pat_mem_pdt_info - Retrieve information about page deallocation table
16571660
* @rinfo: memory pdt information
16581661
*
16591662
*/

0 commit comments

Comments
 (0)