Print this page
12186 The n2rng man page incorrectly refers to n2cp

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man7d/n2rng.7d
          +++ new/usr/src/man/man7d/n2rng.7d
   1    1  '\" te
   2    2  .\" Copyright (c) 2009 Sun Microsystems, Inc.  All Rights Reserved.
        3 +.\" Copyright (c) 2020 Peter Tribble.
   3    4  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4    5  .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5    6  .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6      -.TH N2RNG 7D "Apr 15, 2009"
        7 +.TH N2RNG 7D "Jan 12, 2020"
   7    8  .SH NAME
   8    9  n2rng \- Ultra-SPARC T2 random number generator device driver
   9   10  .SH DESCRIPTION
  10      -.sp
  11      -.LP
  12   11  The \fBn2rng\fR device driver is a multi-threaded, loadable hardware driver
  13      -supporting hardware assisted random numbers. This support is built into the
  14      -Ultra-SPARC T2 CMT processor.
       12 +supporting hardware assisted random numbers.
       13 +This support is built into the Ultra-SPARC T2 and later processors.
  15   14  .sp
  16   15  .LP
  17   16  The \fBn2rng\fR driver requires the presence of the Solaris Cryptographic
  18   17  Framework to enable applications and kernel clients to access the provided
  19   18  services.
  20   19  .SH CONFIGURATION
  21      -.sp
  22      -.LP
  23   20  You configure the \fBn2rng\fR driver by defining properties in
  24      -\fB/platform/sun4v/kernel/drv/n2cp.conf\fR which override the default settings.
       21 +\fB/platform/sun4v/kernel/drv/n2rng.conf\fR which override the default settings.
  25   22  The following property is supported:
  26   23  .sp
  27   24  .ne 2
  28   25  .na
  29   26  \fBnostats\fR
  30   27  .ad
  31   28  .RS 28n
  32      -Disables the generation of statistics. The nostats property may be used to help
  33      -prevent traffic analysis, however, this may inhibit support personnel.
       29 +Disables the generation of statistics.
       30 +The nostats property may be used to help prevent traffic analysis, however,
       31 +this may inhibit support personnel.
  34   32  .RE
  35   33  
  36   34  .SH CRYPTO STATISTICS
       35 +Solaris crypto drivers must implement statistics variables.
       36 +Statistics reported by \fBn2rng\fR may be read using the \fBkstat\fR(1M)
       37 +utility.
       38 +The \fBn2rng\fR driver maintains the following statistics:
  37   39  .sp
  38      -.LP
  39      -Solaris crypto drivers must implement statistics variables. Statistics are
  40      -reported by \fBn2rng\fR using  the \fBkstat\fR(7D) and \fBkstat\fR(9S)
  41      -mechanisms. The \fBn2rng\fR driver maintains the following statistics:
  42      -.sp
  43   40  .ne 2
  44   41  .na
  45   42  \fBstatus\fR
  46   43  .ad
  47   44  .RS 28n
  48   45  Status (online, offline, fail) of RNG device.
  49   46  .RE
  50   47  
  51   48  .sp
  52   49  .ne 2
↓ open down ↓ 7 lines elided ↑ open up ↑
  60   57  .sp
  61   58  .ne 2
  62   59  .na
  63   60  \fBrngbytes\fR
  64   61  .ad
  65   62  .RS 28n
  66   63  Number of bytes read from the RNG device.
  67   64  .RE
  68   65  
  69   66  .SH KERNEL STATISTICS
       67 +The \fBn2rng\fR driver tallies a set of kernel driver statistics when in the
       68 +Control domain.
       69 +Statistics reported by \fBn2rng\fR may be read using the \fBkstat\fR(1M)
       70 +utility.
  70   71  .sp
  71      -.LP
  72      -The \fBn2rng\fR  driver tallies  a set of kernel driver statistics when in the
  73      -Control domain. Statistics are reported by \fBn2rng\fR using  the
  74      -\fBkstat\fR(7D) and \fBkstat\fR(9S) mechanisms. All statistics are maintained
  75      -as unsigned, and all are 64 bits.
  76      -.sp
  77   72  .ne 2
  78   73  .na
  79   74  \fBrng(n)-cell0-bias\fR
  80   75  .ad
  81   76  .RS 28n
  82   77  Bias setting for noise cell 0 of RNG \fIn\fR.
  83   78  .RE
  84   79  
  85   80  .sp
  86   81  .ne 2
↓ open down ↓ 12 lines elided ↑ open up ↑
  99   94  .RS 28n
 100   95  Bias setting for noise cell 1 of RNG \fIn\fR.
 101   96  .RE
 102   97  
 103   98  .sp
 104   99  .ne 2
 105  100  .na
 106  101  \fBrng(n)-cell1-entropy\fR
 107  102  .ad
 108  103  .RS 28n
 109      -Entropy value for noise cell 1 of RNG n.
      104 +Entropy value for noise cell 1 of RNG \fIn\fR.
 110  105  .RE
 111  106  
 112  107  .sp
 113  108  .ne 2
 114  109  .na
 115  110  \fBrng(n)-cell2-bias\fR
 116  111  .ad
 117  112  .RS 28n
 118  113  Bias setting for noise cell 2 of RNG \fIn\fR.
 119  114  .RE
 120  115  
 121  116  .sp
 122  117  .ne 2
 123  118  .na
 124      -\fBrng(n)-cell3-entropy\fR
      119 +\fBrng(n)-cell2-entropy\fR
 125  120  .ad
 126  121  .RS 28n
 127  122  Entropy value for noise cell 2 of RNG \fIn\fR.
 128  123  .RE
 129  124  
 130  125  .sp
 131  126  .ne 2
 132  127  .na
 133  128  \fBrng(n)-state\fR
 134  129  .ad
 135  130  .RS 28n
 136      -State of rng number n (online, offline, error,  health check).
      131 +State of rng number n (online, offline, error, health check).
 137  132  .RE
 138  133  
 139  134  .SH FILES
 140      -.sp
 141  135  .ne 2
 142  136  .na
 143      -\fB\fB/platform/sun4v/kernel/drv/sparcv9/n2cp\fR\fR
      137 +\fB/platform/sun4v/kernel/drv/sparcv9/n2rng\fR
 144  138  .ad
 145  139  .sp .6
 146  140  .RS 4n
 147      -64-bit ELF kernel driver.
      141 +Device driver (SPARC)
 148  142  .RE
 149  143  
 150  144  .sp
 151  145  .ne 2
 152  146  .na
 153      -\fB\fB/platform/sun4v/kernel/drv/n2rng.conf\fR\fR
      147 +\fB/platform/sun4v/kernel/drv/n2rng.conf\fR
 154  148  .ad
 155  149  .sp .6
 156  150  .RS 4n
 157      -Configuration file.
      151 +Driver configuration file
 158  152  .RE
 159  153  
 160  154  .SH ATTRIBUTES
 161      -.sp
 162      -.LP
 163  155  See \fBattributes\fR(5) for descriptions of the following attributes:
 164  156  .sp
 165  157  
 166  158  .sp
 167  159  .TS
 168  160  box;
 169  161  c | c
 170  162  l | l .
 171  163  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 172  164  _
 173  165  Architecture    SPARC
 174  166  _
 175  167  Interface stability     Committed
 176  168  .TE
 177  169  
 178  170  .SH SEE ALSO
 179      -.sp
 180      -.LP
 181      -\fBcryptoadm\fR(1M), \fBkstat\fR(1M), \fBprinters.conf\fR(4),
 182      -\fBattributes\fR(5)
 183      -.sp
 184      -.LP
 185      -\fISolaris Cryptographic Framework - Solaris Software Developer Collection\fR
 186      -.sp
 187      -.LP
 188      -\fISolaris Security for Developer's Guide - Solaris Software Developer
 189      -Collection\fR
      171 +\fBcryptoadm\fR(1M), \fBkstat\fR(1M), \fBattributes\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX