From efd5ecffc9914a2bbe8c042722370a8241b58224 Mon Sep 17 00:00:00 2001 From: jkoshy Date: Thu, 22 Nov 2007 14:09:26 +0000 Subject: [PATCH] - Correct a documentation bug: handles returned from a PMC_OP_PMCALLOCATE request are 32 bit values, and are not necessarily small. - Note that the PMC_F_KGMON flag is currently unimplemented. - Tweak description of an EINVAL error return. - Add an "AUTHORS" section. --- share/man/man4/hwpmc.4 | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4 index 89f4ce3e7e10..1eaf7b05f15e 100644 --- a/share/man/man4/hwpmc.4 +++ b/share/man/man4/hwpmc.4 @@ -1,4 +1,4 @@ -.\" Copyright (c) 2003-2005 Joseph Koshy +.\" Copyright (c) 2003-2007 Joseph Koshy .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 13, 2007 +.Dd November 22, 2007 .Dt HWPMC 4 .Os .Sh NAME @@ -196,6 +196,7 @@ sampling mode. It signifies that the PMC's sampling interrupt is to be used to drive kernel profiling via .Xr kgmon 8 . +This functionality is currently unimplemented. .It Dv PMC_F_LOG_PROCCSW This modifier is valid only for a PMC being allocated in process-private mode. @@ -286,7 +287,7 @@ the hardware PMCs managed by the driver. .It Dv PMC_OP_PMCALLOCATE Allocate and configure a PMC. -On successful allocation, a handle to the PMC (a small integer) +On successful allocation, a handle to the PMC (a 32 bit value) is returned. .It Dv PMC_OP_PMCATTACH Attach a process mode PMC to a target process. @@ -577,7 +578,7 @@ of this PMC. .It Bq Er EFAULT A bad address was passed in to the driver. .It Bq Er EINVAL -A process specified an invalid PMC handle. +An invalid PMC handle was specified. .It Bq Er EINVAL An invalid CPU number was passed in for a .Dv PMC_OP_GETPMCINFO @@ -734,6 +735,12 @@ The .Nm driver first appeared in .Fx 6.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An "Joseph Koshy" +.Aq jkoshy@FreeBSD.org . .Sh BUGS The driver samples the state of the kernel's logical processor support at the time of initialization (i.e., at module load time).