1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate * CDDL HEADER START
3*0Sstevel@tonic-gate *
4*0Sstevel@tonic-gate * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance
7*0Sstevel@tonic-gate * with the License.
8*0Sstevel@tonic-gate *
9*0Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate * and limitations under the License.
13*0Sstevel@tonic-gate *
14*0Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate *
20*0Sstevel@tonic-gate * CDDL HEADER END
21*0Sstevel@tonic-gate */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate * Copyright (c) 1999-2000 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate * All rights reserved.
25*0Sstevel@tonic-gate */
26*0Sstevel@tonic-gate
27*0Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI"
28*0Sstevel@tonic-gate
29*0Sstevel@tonic-gate /*
30*0Sstevel@tonic-gate * t1394_errmsg.c
31*0Sstevel@tonic-gate * Utility function that targets can use to convert an error code into a
32*0Sstevel@tonic-gate * printable string.
33*0Sstevel@tonic-gate */
34*0Sstevel@tonic-gate
35*0Sstevel@tonic-gate #include <sys/tnf_probe.h>
36*0Sstevel@tonic-gate
37*0Sstevel@tonic-gate #include <sys/1394/t1394.h>
38*0Sstevel@tonic-gate #include <sys/1394/s1394.h>
39*0Sstevel@tonic-gate #include <sys/1394/cmd1394.h>
40*0Sstevel@tonic-gate #include <sys/1394/ixl1394.h>
41*0Sstevel@tonic-gate
42*0Sstevel@tonic-gate static const char *error_string[] = {
43*0Sstevel@tonic-gate "CMD1394_CMDSUCCESS: Command Success", /* 0 */
44*0Sstevel@tonic-gate "", /* -1 */
45*0Sstevel@tonic-gate "", /* -2 */
46*0Sstevel@tonic-gate "", /* -3 */
47*0Sstevel@tonic-gate "", /* -4 */
48*0Sstevel@tonic-gate "", /* -5 */
49*0Sstevel@tonic-gate "", /* -6 */
50*0Sstevel@tonic-gate "", /* -7 */
51*0Sstevel@tonic-gate "", /* -8 */
52*0Sstevel@tonic-gate "", /* -9 */
53*0Sstevel@tonic-gate "CMD1394_ENULL_MBLK: NULL mblk pointer", /* -10 */
54*0Sstevel@tonic-gate "CMD1394_EMBLK_TOO_SMALL: Mblk too small", /* -11 */
55*0Sstevel@tonic-gate "CMD1394_ESTALE_GENERATION: Stale generation", /* -12 */
56*0Sstevel@tonic-gate "CMD1394_EDEVICE_REMOVED: Device removed", /* -13 */
57*0Sstevel@tonic-gate "CMD1394_EINVALID_CONTEXT: Invalid context", /* -14 */
58*0Sstevel@tonic-gate "CMD1394_EINVALID_COMMAND: Invalid command", /* -15 */
59*0Sstevel@tonic-gate "CMD1394_EUNKNOWN_ERROR: Unknown error", /* -16 */
60*0Sstevel@tonic-gate "CMD1394_NOSTATUS: No status", /* -17 */
61*0Sstevel@tonic-gate "CMD1394_EFATAL_ERROR: Fatal error", /* -18 */
62*0Sstevel@tonic-gate "CMD1394_ENO_ATREQ: Unable to send ATREQ", /* -19 */
63*0Sstevel@tonic-gate "CMD1394_EDEVICE_ERROR: Device error", /* -20 */
64*0Sstevel@tonic-gate "", /* -21 */
65*0Sstevel@tonic-gate "", /* -22 */
66*0Sstevel@tonic-gate "", /* -23 */
67*0Sstevel@tonic-gate "", /* -24 */
68*0Sstevel@tonic-gate "", /* -25 */
69*0Sstevel@tonic-gate "", /* -26 */
70*0Sstevel@tonic-gate "", /* -27 */
71*0Sstevel@tonic-gate "", /* -28 */
72*0Sstevel@tonic-gate "", /* -29 */
73*0Sstevel@tonic-gate "CMD1394_EDEVICE_BUSY: Device busy", /* -30 */
74*0Sstevel@tonic-gate "CMD1394_ERETRIES_EXCEEDED: Too many retries", /* -31 */
75*0Sstevel@tonic-gate "CMD1394_ETYPE_ERROR: Resp/ack type error", /* -32 */
76*0Sstevel@tonic-gate "CMD1394_EDATA_ERROR: Resp/ack data error", /* -33 */
77*0Sstevel@tonic-gate "CMD1394_EBUSRESET: Bus reset", /* -34 */
78*0Sstevel@tonic-gate "CMD1394_EADDRESS_ERROR: Address error", /* -35 */
79*0Sstevel@tonic-gate "CMD1394_ETIMEOUT: Command timed out", /* -36 */
80*0Sstevel@tonic-gate "CMD1394_ERSRC_CONFLICT: Resource conflict" /* -37 */
81*0Sstevel@tonic-gate };
82*0Sstevel@tonic-gate
83*0Sstevel@tonic-gate static const char *ixl_compilation_error_string[] = {
84*0Sstevel@tonic-gate "IXL1394_EMEM_ALLOC_FAIL: Memory allocation failed", /* -301 */
85*0Sstevel@tonic-gate "IXL1394_EBAD_IXL_OPCODE: Bad opcode", /* -302 */
86*0Sstevel@tonic-gate "IXL1394_EFRAGMENT_OFLO: Descriptor block overflow", /* -303 */
87*0Sstevel@tonic-gate "IXL1394_ENO_DATA_PKTS: No descriptor blocks", /* -304 */
88*0Sstevel@tonic-gate "IXL1394_EMISPLACED_RECV: Misplaced receive", /* -305 */
89*0Sstevel@tonic-gate "IXL1394_EMISPLACED_SEND: Misplaced send", /* -306 */
90*0Sstevel@tonic-gate "IXL1394_EPKT_HDR_MISSING: Packet header missing", /* -307 */
91*0Sstevel@tonic-gate "IXL1394_ENULL_BUFFER_ADDR: NULL buffer address", /* -308 */
92*0Sstevel@tonic-gate "IXL1394_EPKTSIZE_MAX_OFLO: Packet > 0xFFFF bytes", /* -309 */
93*0Sstevel@tonic-gate "IXL1394_EPKTSIZE_RATIO: Improper packet length/count", /* -310 */
94*0Sstevel@tonic-gate "IXL1394_EUNAPPLIED_SET_CMD: Unused set command", /* -311 */
95*0Sstevel@tonic-gate "IXL1394_EDUPLICATE_SET_CMD: Multiple set commands", /* -312 */
96*0Sstevel@tonic-gate "IXL1394_EJUMP_NOT_TO_LABEL: Jump destination not a label", /* -313 */
97*0Sstevel@tonic-gate "IXL1394_EUPDATE_DISALLOWED: Update not allowed ", /* -314 */
98*0Sstevel@tonic-gate "IXL1394_EBAD_SKIPMODE: Invalid skip mode", /* -315 */
99*0Sstevel@tonic-gate "IXL1394_EWRONG_XR_CMD_MODE: Inapproriate xmit/recv mode", /* -316 */
100*0Sstevel@tonic-gate "IXL1394_EINTERNAL_ERROR: Internal error", /* -317 */
101*0Sstevel@tonic-gate "IXL1394_ENOT_IMPLEMENTED: Unimplemented error", /* -318 */
102*0Sstevel@tonic-gate "IXL1394_EOPCODE_MISMATCH: Opcode mismatch", /* -319 */
103*0Sstevel@tonic-gate "IXL1394_EOPCODE_DISALLOWED: Opcode disallowed for update", /* -320 */
104*0Sstevel@tonic-gate "IXL1394_EBAD_SKIP_LABEL: Skip label destination not a label",
105*0Sstevel@tonic-gate "IXL1394_EXFER_BUF_MISSING: Missing buffer in transfer command",
106*0Sstevel@tonic-gate "IXL1394_EXFER_BUF_CNT_DIFF: Packet count differs in new buffer",
107*0Sstevel@tonic-gate "IXL1394_EORIG_IXL_CORRUPTED: Original IXL program corrupted",
108*0Sstevel@tonic-gate "IXL1394_ECOUNT_MISMATCH: IXL command count difference", /* -325 */
109*0Sstevel@tonic-gate "IXL1394_EPRE_UPD_DMALOST: DMA path lost before update", /* -326 */
110*0Sstevel@tonic-gate "IXL1394_EPOST_UPD_DMALOST: DMA path lost after update", /* -327 */
111*0Sstevel@tonic-gate "IXL1394_ERISK_PROHIBITS_UPD: Risk prohibits update" /* -328 */
112*0Sstevel@tonic-gate };
113*0Sstevel@tonic-gate
114*0Sstevel@tonic-gate static const char *addr_error_string[] = {
115*0Sstevel@tonic-gate "T1394_EALLOC_ADDR: Unable to alloc 1394 address block", /* -400 */
116*0Sstevel@tonic-gate };
117*0Sstevel@tonic-gate
118*0Sstevel@tonic-gate static const char *cec_error_string[] = {
119*0Sstevel@tonic-gate "T1394_ENO_BANDWIDTH: Bandwidth allocation failed", /* -500 */
120*0Sstevel@tonic-gate "T1394_ENO_CHANNEL: Channel allocation failed", /* -501 */
121*0Sstevel@tonic-gate "T1394_ETARGET: One or more callbacks failed in isoch setup" /* -502 */
122*0Sstevel@tonic-gate };
123*0Sstevel@tonic-gate
124*0Sstevel@tonic-gate static const char *idma_error_string[] = {
125*0Sstevel@tonic-gate "T1394_EIDMA_NO_RESRCS: No DMA resources", /* -600 */
126*0Sstevel@tonic-gate "T1394_EIDMA_CONFLICT: Conflicting arguments" /* -601 */
127*0Sstevel@tonic-gate };
128*0Sstevel@tonic-gate
129*0Sstevel@tonic-gate static const char *cfgrom_error_string[] = {
130*0Sstevel@tonic-gate "T1394_ECFGROM_FULL: Config ROM is full", /* -700 */
131*0Sstevel@tonic-gate "T1394_EINVALID_PARAM: Invalid parameter in call", /* -701 */
132*0Sstevel@tonic-gate "T1394_EINVALID_CONTEXT: Invalid context for call", /* -702 */
133*0Sstevel@tonic-gate "T1394_NOERROR: No error" /* -703 */
134*0Sstevel@tonic-gate };
135*0Sstevel@tonic-gate
136*0Sstevel@tonic-gate #define T1394_ERRMSG_EMPTY_STRING ""
137*0Sstevel@tonic-gate
138*0Sstevel@tonic-gate /*
139*0Sstevel@tonic-gate * Function: t1394_errmsg()
140*0Sstevel@tonic-gate * Input(s): result Result code
141*0Sstevel@tonic-gate * flags The flags parameter is unused (for now)
142*0Sstevel@tonic-gate *
143*0Sstevel@tonic-gate * Output(s): const string; empty string if invalid result code is passed in
144*0Sstevel@tonic-gate *
145*0Sstevel@tonic-gate * Description: t1394_errmsg() returns a string corresponding the error code
146*0Sstevel@tonic-gate */
147*0Sstevel@tonic-gate /* ARGSUSED */
148*0Sstevel@tonic-gate const char *
t1394_errmsg(int result,uint_t flags)149*0Sstevel@tonic-gate t1394_errmsg(int result, uint_t flags)
150*0Sstevel@tonic-gate {
151*0Sstevel@tonic-gate int err;
152*0Sstevel@tonic-gate const char *msg = T1394_ERRMSG_EMPTY_STRING;
153*0Sstevel@tonic-gate
154*0Sstevel@tonic-gate TNF_PROBE_1_DEBUG(t1394_errmsg_enter, S1394_TNF_SL_STACK, "",
155*0Sstevel@tonic-gate tnf_int, argument, result);
156*0Sstevel@tonic-gate
157*0Sstevel@tonic-gate if (result > 0) {
158*0Sstevel@tonic-gate TNF_PROBE_2(t1394_errmsg, S1394_TNF_SL_ERROR, "",
159*0Sstevel@tonic-gate tnf_string, msg, "invalid result argument",
160*0Sstevel@tonic-gate tnf_int, result, result);
161*0Sstevel@tonic-gate TNF_PROBE_0_DEBUG(t1394_errmsg_exit, S1394_TNF_SL_STACK, "");
162*0Sstevel@tonic-gate return (T1394_ERRMSG_EMPTY_STRING);
163*0Sstevel@tonic-gate }
164*0Sstevel@tonic-gate
165*0Sstevel@tonic-gate result = -result;
166*0Sstevel@tonic-gate
167*0Sstevel@tonic-gate if ((result >= -CMD1394_ERR_FIRST) && (result <= -CMD1394_ERR_LAST)) {
168*0Sstevel@tonic-gate err = result - (-CMD1394_ERR_FIRST);
169*0Sstevel@tonic-gate msg = error_string[err];
170*0Sstevel@tonic-gate } else if ((result >= -IXL1394_COMP_ERR_FIRST) &&
171*0Sstevel@tonic-gate (result <= -IXL1394_COMP_ERR_LAST)) {
172*0Sstevel@tonic-gate err = result - (-IXL1394_COMP_ERR_FIRST);
173*0Sstevel@tonic-gate msg = ixl_compilation_error_string[err];
174*0Sstevel@tonic-gate } else if ((result >= -T1394_EADDR_FIRST) &&
175*0Sstevel@tonic-gate (result <= -T1394_EADDR_LAST)) {
176*0Sstevel@tonic-gate err = result - (-T1394_EADDR_FIRST);
177*0Sstevel@tonic-gate msg = addr_error_string[err];
178*0Sstevel@tonic-gate } else if ((result >= -T1394_CEC_ERR_FIRST) &&
179*0Sstevel@tonic-gate (result <= -T1394_CEC_ERR_LAST)) {
180*0Sstevel@tonic-gate err = result - (-T1394_CEC_ERR_FIRST);
181*0Sstevel@tonic-gate msg = cec_error_string[err];
182*0Sstevel@tonic-gate } else if ((result >= -T1394_IDMA_ERR_FIRST) &&
183*0Sstevel@tonic-gate (result <= -T1394_IDMA_ERR_LAST)) {
184*0Sstevel@tonic-gate err = result - (-T1394_IDMA_ERR_FIRST);
185*0Sstevel@tonic-gate msg = idma_error_string[err];
186*0Sstevel@tonic-gate } else if ((result >= -T1394_ECFG_FIRST) &&
187*0Sstevel@tonic-gate (result <= -T1394_ECFG_LAST)) {
188*0Sstevel@tonic-gate err = result - (-T1394_ECFG_FIRST);
189*0Sstevel@tonic-gate msg = cfgrom_error_string[err];
190*0Sstevel@tonic-gate } else {
191*0Sstevel@tonic-gate TNF_PROBE_2(t1394_errmsg, S1394_TNF_SL_ERROR, "",
192*0Sstevel@tonic-gate tnf_string, msg, "invalid result argument",
193*0Sstevel@tonic-gate tnf_int, result, result);
194*0Sstevel@tonic-gate }
195*0Sstevel@tonic-gate
196*0Sstevel@tonic-gate TNF_PROBE_0_DEBUG(t1394_errmsg_exit, S1394_TNF_SL_STACK, "");
197*0Sstevel@tonic-gate
198*0Sstevel@tonic-gate return (msg);
199*0Sstevel@tonic-gate }
200