usr/src/man/man9e/print.9e

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\" Copyright (c) 1997, Sun Microsystems, Inc., All Rights Reserved
   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.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH PRINT 9E "Sep 15, 1992"
   8 .SH NAME
   9 print \- display a driver message on system console
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/errno.h>
  15 #include <sys/ddi.h>
  16 #include <sys/sunddi.h>
  17
  18
  19
  20 \fBint prefix\fR\fBprint\fR(\fBdev_t\fR \fIdev\fR, \fBchar *\fR\fIstr\fR);
  21 .fi
  22
  23 .SH INTERFACE LEVEL
  24 .sp
  25 .LP
  26 Architecture independent level 1 (DDI/DKI). This entry point is required for
  27 block devices.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIdev\fR \fR
  33 .ad
  34 .RS 8n
  35 Device number.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIstr\fR \fR
  42 .ad
  43 .RS 8n
  44 Pointer to a character string describing the problem.
  45 .RE
  46
  47 .SH DESCRIPTION
  48 .sp
  49 .LP
  50 The \fBprint()\fR routine is called by the kernel when it has detected an
  51 exceptional condition (such as out of space) in the device.  To display the
  52 message on the console, the driver should use the  \fBcmn_err\fR(9F) kernel
  53 function. The driver should print the message along with any driver specific
  54 information.
  55 .SH RETURN VALUES
  56 .sp
  57 .LP
  58 The  \fBprint()\fR routine should return \fB0\fR for success, or the
  59 appropriate error number.  The  \fBprint\fR routine can fail if the driver
  60 implemented a non-standard  \fBprint()\fR routine that attempted to perform
  61 error logging, but was unable to complete the logging for whatever reason.
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBcmn_err\fR(9F)
  66 .sp
  67 .LP
  68 \fIWriting Device Drivers\fR