Commit c13ff6f3 authored by Nathan Lynch's avatar Nathan Lynch Committed by Michael Ellerman
Browse files

powerpc/rtas: improve ppc_rtas_rmo_buf_show documentation 



Add kerneldoc for ppc_rtas_rmo_buf_show(), the callback for
/proc/powerpc/rtas/rmo_buffer, explaining its expected use.

Signed-off-by: default avatarNathan Lynch <nathanl@linux.ibm.com>
Reviewed-by: default avatarAlexey Kardashevskiy <aik@ozlabs.ru>
Reviewed-by: default avatarAndrew Donnellan <ajd@linux.ibm.com>
Signed-off-by: default avatarMichael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20210408140630.205502-2-nathanl@linux.ibm.com
parent 5ae5bc12

arch/powerpc/kernel/rtas-proc.c

+10 −1
Original line number Diff line number Diff line
@@ -757,7 +757,16 @@ static int ppc_rtas_tone_volume_show(struct seq_file *m, void *v) 


#define RMO_READ_BUF_MAX 30



/* RTAS Userspace access */

/**

 * ppc_rtas_rmo_buf_show() - Describe RTAS-addressable region for user space.

 *

 * Base + size description of a range of RTAS-addressable memory set

 * aside for user space to use as work area(s) for certain RTAS

 * functions. User space accesses this region via /dev/mem. Apart from

 * security policies, the kernel does not arbitrate or serialize

 * access to this region, and user space must ensure that concurrent

 * users do not interfere with each other.

 */

static int ppc_rtas_rmo_buf_show(struct seq_file *m, void *v)

{

	seq_printf(m, "%016lx %x\n", rtas_rmo_buf, RTAS_RMOBUF_MAX);