xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_status.h (revision 97f44cd39e4ff816eaa1710279d28cf6b9e65ad9)
1 /*
2  * Copyright (c) 2014-2020 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /**
20  * DOC: qdf_status
21  * QCA driver framework (QDF) status codes
22  * Basic status codes/definitions used by QDF
23  */
24 
25 #ifndef __QDF_STATUS_H
26 #define __QDF_STATUS_H
27 
28 /**
29  * typedef QDF_STATUS - QDF error codes
30  * @QDF_STATUS_SUCCESS: success
31  * @QDF_STATUS_E_RESOURCES: system resource(other than memory) not available
32  * @QDF_STATUS_E_NOMEM: not enough memory
33  * @QDF_STATUS_E_AGAIN: try again
34  * @QDF_STATUS_E_INVAL: invalid request
35  * @QDF_STATUS_E_FAULT: system fault
36  * @QDF_STATUS_E_ALREADY: another request already in progress
37  * @QDF_STATUS_E_BADMSG: bad message
38  * @QDF_STATUS_E_BUSY: device or resource busy
39  * @QDF_STATUS_E_CANCELED: request cancelled
40  * @QDF_STATUS_E_ABORTED: request aborted
41  * @QDF_STATUS_E_NOSUPPORT: request not supported
42  * @QDF_STATUS_E_PERM: operation not permitted
43  * @QDF_STATUS_E_EMPTY: empty condition
44  * @QDF_STATUS_E_EXISTS: existence failure
45  * @QDF_STATUS_E_TIMEOUT: operation timeout
46  * @QDF_STATUS_E_FAILURE: unknown reason do not use unless nothing else applies
47  * @QDF_STATUS_E_NOENT: No such file or directory
48  * @QDF_STATUS_E_E2BIG: Arg list too long
49  * @QDF_STATUS_E_NOSPC: no space left on device
50  * @QDF_STATUS_E_ADDRNOTAVAIL: Cannot assign requested address
51  * @QDF_STATUS_E_ENXIO: No such device or address
52  * @QDF_STATUS_E_NETDOWN: network is down
53  * @QDF_STATUS_E_IO: I/O Error
54  * @QDF_STATUS_E_PENDING: pending status
55  * @QDF_STATUS_E_NETRESET: Network dropped connection because of reset
56  * @QDF_STATUS_E_SIG: Exit due to received SIGINT
57  * @QDF_STATUS_E_PROTO: protocol error
58  * @QDF_STATUS_NOT_INITIALIZED: resource not initialized
59  * @QDF_STATUS_E_NULL_VALUE: request is null
60  * @QDF_STATUS_HEARTBEAT_TMOUT: hearbeat timeout error
61  * @QDF_STATUS_NTH_BEACON_DELIVERY: Nth beacon delivery
62  * @QDF_STATUS_CSR_WRONG_STATE: csr in wrong state
63  * @QDF_STATUS_FT_PREAUTH_KEY_SUCCESS: ft preauth key success
64  * @QDF_STATUS_FT_PREAUTH_KEY_FAILED: ft preauth key failed
65  * @QDF_STATUS_CMD_NOT_QUEUED: command not queued
66  * @QDF_STATUS_FW_MSG_TIMEDOUT: target message timeout
67  * @QDF_STATUS_E_USB_ERROR: USB transaction error
68  * @QDF_STATUS_MAXCOMP_FAIL: Component id is more than MAX UMAC components
69  * @QDF_STATUS_COMP_DISABLED: UMAC Component is disabled
70  * @QDF_STATUS_COMP_ASYNC: UMAC component runs in asynchronous communication
71  * @QDF_STATUS_CRYPTO_PN_ERROR: PN ERROR in received frame
72  * @QDF_STATUS_CRYPTO_MIC_FAILURE: MIC failure in received frame
73  * @QDF_STATUS_CRYPTO_ENCRYPT_FAILED: encryption failed
74  * @QDF_STATUS_CRYPTO_DECRYPT_FAILED: decryption failed
75  * @QDF_STATUS_E_RANGE: result/parameter/operation was out of range
76  * @QDF_STATUS_E_GRO_DROP: return code for GRO drop
77  * @QDF_STATUS_MAX: not a realy value just a place holder for max
78  */
79 typedef enum {
80 	QDF_STATUS_SUCCESS,
81 	QDF_STATUS_E_RESOURCES,
82 	QDF_STATUS_E_NOMEM,
83 	QDF_STATUS_E_AGAIN,
84 	QDF_STATUS_E_INVAL,
85 	QDF_STATUS_E_FAULT,
86 	QDF_STATUS_E_ALREADY,
87 	QDF_STATUS_E_BADMSG,
88 	QDF_STATUS_E_BUSY,
89 	QDF_STATUS_E_CANCELED,
90 	QDF_STATUS_E_ABORTED,
91 	QDF_STATUS_E_NOSUPPORT,
92 	QDF_STATUS_E_PERM,
93 	QDF_STATUS_E_EMPTY,
94 	QDF_STATUS_E_EXISTS,
95 	QDF_STATUS_E_TIMEOUT,
96 	QDF_STATUS_E_FAILURE,
97 	QDF_STATUS_E_NOENT,
98 	QDF_STATUS_E_E2BIG,
99 	QDF_STATUS_E_NOSPC,
100 	QDF_STATUS_E_ADDRNOTAVAIL,
101 	QDF_STATUS_E_ENXIO,
102 	QDF_STATUS_E_NETDOWN,
103 	QDF_STATUS_E_IO,
104 	QDF_STATUS_E_PENDING,
105 	QDF_STATUS_E_NETRESET,
106 	QDF_STATUS_E_SIG,
107 	QDF_STATUS_E_PROTO,
108 	QDF_STATUS_NOT_INITIALIZED,
109 	QDF_STATUS_E_NULL_VALUE,
110 	QDF_STATUS_HEARTBEAT_TMOUT,
111 	QDF_STATUS_NTH_BEACON_DELIVERY,
112 	QDF_STATUS_CSR_WRONG_STATE,
113 	QDF_STATUS_FT_PREAUTH_KEY_SUCCESS,
114 	QDF_STATUS_FT_PREAUTH_KEY_FAILED,
115 	QDF_STATUS_CMD_NOT_QUEUED,
116 	QDF_STATUS_FW_MSG_TIMEDOUT,
117 	QDF_STATUS_E_USB_ERROR,
118 	QDF_STATUS_MAXCOMP_FAIL,
119 	QDF_STATUS_COMP_DISABLED,
120 	QDF_STATUS_COMP_ASYNC,
121 	QDF_STATUS_CRYPTO_PN_ERROR,
122 	QDF_STATUS_CRYPTO_MIC_FAILURE,
123 	QDF_STATUS_CRYPTO_ENCRYPT_FAILED,
124 	QDF_STATUS_CRYPTO_DECRYPT_FAILED,
125 	QDF_STATUS_E_DEFRAG_ERROR,
126 	QDF_STATUS_E_RANGE,
127 	QDF_STATUS_E_GRO_DROP,
128 	QDF_STATUS_MAX
129 } QDF_STATUS;
130 
131 #define QDF_IS_STATUS_SUCCESS(status) (QDF_STATUS_SUCCESS == (status))
132 #define QDF_IS_STATUS_ERROR(status) (QDF_STATUS_SUCCESS != (status))
133 
134 /**
135  * qdf_status_to_os_return() - map a QDF_STATUS into an OS specific return code
136  * @status: QDF_STATUS to map
137  *
138  * Return: an OS specific error code
139  */
140 int qdf_status_to_os_return(QDF_STATUS status);
141 
142 /**
143  * qdf_status_from_os_return() - map an OS specific return code to a QDF_STATUS
144  * @rc: the input return code to map
145  *
146  * Return: QDF_STATUS
147  */
148 QDF_STATUS qdf_status_from_os_return(int rc);
149 
150 #endif /* __QDF_STATUS_H */
151 
152