Skip to content

Commit 88372ad

Browse files
ssrish17maddy-kerneldev
authored andcommitted
pseries/plpks: fix kernel-doc comment inconsistencies
Fix issues with comments for all the applicable functions to be consistent with kernel-doc format. Move them before the function definition as opposed to the function prototype. Signed-off-by: Srish Srinivasan <ssrish@linux.ibm.com> Tested-by: Nayna Jain <nayna@linux.ibm.com> Reviewed-by: Nayna Jain <nayna@linux.ibm.com> Signed-off-by: Madhavan Srinivasan <maddy@linux.ibm.com> Link: https://patch.msgid.link/20260127145228.48320-2-ssrish@linux.ibm.com
1 parent 33c1c6d commit 88372ad

2 files changed

Lines changed: 318 additions & 87 deletions

File tree

arch/powerpc/include/asm/plpks.h

Lines changed: 0 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -67,122 +67,45 @@ struct plpks_var_name_list {
6767
struct plpks_var_name varlist[];
6868
};
6969

70-
/**
71-
* Updates the authenticated variable. It expects NULL as the component.
72-
*/
7370
int plpks_signed_update_var(struct plpks_var *var, u64 flags);
7471

75-
/**
76-
* Writes the specified var and its data to PKS.
77-
* Any caller of PKS driver should present a valid component type for
78-
* their variable.
79-
*/
8072
int plpks_write_var(struct plpks_var var);
8173

82-
/**
83-
* Removes the specified var and its data from PKS.
84-
*/
8574
int plpks_remove_var(char *component, u8 varos,
8675
struct plpks_var_name vname);
8776

88-
/**
89-
* Returns the data for the specified os variable.
90-
*
91-
* Caller must allocate a buffer in var->data with length in var->datalen.
92-
* If no buffer is provided, var->datalen will be populated with the object's
93-
* size.
94-
*/
9577
int plpks_read_os_var(struct plpks_var *var);
9678

97-
/**
98-
* Returns the data for the specified firmware variable.
99-
*
100-
* Caller must allocate a buffer in var->data with length in var->datalen.
101-
* If no buffer is provided, var->datalen will be populated with the object's
102-
* size.
103-
*/
10479
int plpks_read_fw_var(struct plpks_var *var);
10580

106-
/**
107-
* Returns the data for the specified bootloader variable.
108-
*
109-
* Caller must allocate a buffer in var->data with length in var->datalen.
110-
* If no buffer is provided, var->datalen will be populated with the object's
111-
* size.
112-
*/
11381
int plpks_read_bootloader_var(struct plpks_var *var);
11482

115-
/**
116-
* Returns if PKS is available on this LPAR.
117-
*/
11883
bool plpks_is_available(void);
11984

120-
/**
121-
* Returns version of the Platform KeyStore.
122-
*/
12385
u8 plpks_get_version(void);
12486

125-
/**
126-
* Returns hypervisor storage overhead per object, not including the size of
127-
* the object or label. Only valid for config version >= 2
128-
*/
12987
u16 plpks_get_objoverhead(void);
13088

131-
/**
132-
* Returns maximum password size. Must be >= 32 bytes
133-
*/
13489
u16 plpks_get_maxpwsize(void);
13590

136-
/**
137-
* Returns maximum object size supported by Platform KeyStore.
138-
*/
13991
u16 plpks_get_maxobjectsize(void);
14092

141-
/**
142-
* Returns maximum object label size supported by Platform KeyStore.
143-
*/
14493
u16 plpks_get_maxobjectlabelsize(void);
14594

146-
/**
147-
* Returns total size of the configured Platform KeyStore.
148-
*/
14995
u32 plpks_get_totalsize(void);
15096

151-
/**
152-
* Returns used space from the total size of the Platform KeyStore.
153-
*/
15497
u32 plpks_get_usedspace(void);
15598

156-
/**
157-
* Returns bitmask of policies supported by the hypervisor.
158-
*/
15999
u32 plpks_get_supportedpolicies(void);
160100

161-
/**
162-
* Returns maximum byte size of a single object supported by the hypervisor.
163-
* Only valid for config version >= 3
164-
*/
165101
u32 plpks_get_maxlargeobjectsize(void);
166102

167-
/**
168-
* Returns bitmask of signature algorithms supported for signed updates.
169-
* Only valid for config version >= 3
170-
*/
171103
u64 plpks_get_signedupdatealgorithms(void);
172104

173-
/**
174-
* Returns the length of the PLPKS password in bytes.
175-
*/
176105
u16 plpks_get_passwordlen(void);
177106

178-
/**
179-
* Called in early init to retrieve and clear the PLPKS password from the DT.
180-
*/
181107
void plpks_early_init_devtree(void);
182108

183-
/**
184-
* Populates the FDT with the PLPKS password to prepare for kexec.
185-
*/
186109
int plpks_populate_fdt(void *fdt);
187110
#else // CONFIG_PSERIES_PLPKS
188111
static inline bool plpks_is_available(void) { return false; }

0 commit comments

Comments
 (0)