Additional doxygen updates
[keystone-rtos/netapi.git] / ti / runtime / netapi / netapi_err.h
1 /*******************************
2  * file: netapi_err.h
3  * purpose: netapi error codes
4  **************************************************************
5  * @file netapi.h
6  * 
7  * @brief DESCRIPTION:  netapi Error Definitions for user space transport
8  *               library
9  * 
10  * REVISION HISTORY:  rev 0.0.1 
11  *
12  *  Copyright (c) Texas Instruments Incorporated 2010-2011
13  * 
14  *  Redistribution and use in source and binary forms, with or without 
15  *  modification, are permitted provided that the following conditions 
16  *  are met:
17  *
18  *    Redistributions of source code must retain the above copyright 
19  *    notice, this list of conditions and the following disclaimer.
20  *
21  *    Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the 
23  *    documentation and/or other materials provided with the   
24  *    distribution.
25  *
26  *    Neither the name of Texas Instruments Incorporated nor the names of
27  *    its contributors may be used to endorse or promote products derived
28  *    from this software without specific prior written permission.
29  *
30  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
31  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
32  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
33  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
34  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
35  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
36  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
37  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
38  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
39  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
40  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  ******************************/
44 #ifndef __NETAPI_ERR__
45 #define __NETAPI_ERR__
47 /** @defgroup netapi_errors NETAPI Error Return Values
48  *  @ingroup netapi
49  */
51 /**
52  *  @def  NETAPI_ERR_OK
53  *  @ingroup netapi_errors
54  *       No error 
55  */
56 #define NETAPI_ERR_OK  0
58 /**
59  *  @def  NETAPI_ERR_NOMEM
60  *  @ingroup netapi_errors
61  *  @brief   out of memory error  
62  */
63 #define NETAPI_ERR_NOMEM -1
65 /**
66  *  @def  NETAPI_ERR_BAD_INPUT
67  *  @ingroup netapi_errors
68  *  @brief   arguments or configuraiton is invalid
69  */
70 #define NETAPI_ERR_BAD_INPUT -2
72 /**
73  *  @def  NETAPI_ERR_QLLD 
74  *  @ingroup netapi_errors
75  *  @brief   QUEUE MANAGER Reports an error
76  */
77 #define NETAPI_ERR_QLLD -3
79 /**
80  *  @def  NETAPI_ERR_NOTFOUND
81  *  @ingroup netapi_errors
82  *  @brief   the resource cannot be located
83  */
84 #define NETAPI_ERR_NOTFOUND -4
85 /**
86  *  @def  NETAPI_ERR_BUSY
87  *  @ingroup netapi_errors
88  *  @brief   Temporarily out of resources or resource leak
89  */
90 #define NETAPI_ERR_BUSY -5 
92 /**
93  *  @def  NETAPI_ERR_NWAL_ERR0
94  *  @ingroup netapi_errors
95  *  @brief   NWAL subsytem reports error 
96  */
97 #define NETAPI_ERR_NWAL_ERR0 -6
99 /**
100  *  @def  NETAPI_ERR_NOT_IMLEMENTED_
101  *  @ingroup netapi_errors
102  *  @brief   Feature not implemented in this version    
103  */
104 #define NETAPI_ERR_NOT_IMPLEMENTED -7
106 /**
107  *  @def  NETAPI_ERR_NORES
108  *  @ingroup netapi_errors
109  *  @brief   no free (hw) resources available 
110  */
111 #define NETAPI_ERR_NORES -8
113 /**
114  *  @def  NETAPI_ERR_ALREADY_CANCELLED
115  *  @ingroup netapi_errors
116  *  @brief   timer has already been cancelled
117  */
118 #define NETAPI_ERR_ALREADY_CANCELLED -100
120 /**
121  *  @def  NETAPI_ERR_NWAL_TX_ERR
122  *  @ingroup netapi_errors
123  *  @brief   error trying to send to NWAL. 
124  */
125 #define NETAPI_ERR_NWAL_TX_ERR -65536
126 #endif