1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
* MOST NetServices "Light" V3.2.7.0.1796 MultiInstance Patch
*
* Copyright (C) 2015 Microchip Technology Germany II GmbH & Co. KG
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* You may also obtain this software under a propriety license from Microchip.
* Please contact Microchip for further information.
*
*/
/*!
* \file
* \brief This header file contains standard return values used by MOST NetServices functions
* and methods.
* \addtogroup G_MNS_MISC_RET_RES
* @{
*/
#ifndef MNS_RET_H
#define MNS_RET_H
#ifdef __cplusplus
extern "C"
{
#endif
/*------------------------------------------------------------------------------------------------*/
/* Enumerations */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Standard return codes used for synchronous response */
typedef enum Mns_Return_
{
MNS_RET_SUCCESS = 0x00, /*!< \brief Operation successfully completed */
MNS_RET_ERR_PARAM = 0x01, /*!< \brief At least one parameter exceeds its
admissible range */
MNS_RET_ERR_BUFFER_OVERFLOW = 0x02, /*!< \brief Buffer overflow or service busy */
MNS_RET_ERR_NOT_AVAILABLE = 0x03, /*!< \brief Functionality not available */
MNS_RET_ERR_NOT_SUPPORTED = 0x04, /*!< \brief This function is not supported by this
derivative of INIC / physical layer / MOST
speed */
MNS_RET_ERR_INVALID_SHADOW = 0x05, /*!< \brief The requested information is not yet
available */
MNS_RET_ERR_ALREADY_SET = 0x06, /*!< \brief The value to be set is already set. The
application can therefore be aware that no
message will be send to INIC and no
callback will be called */
MNS_RET_ERR_API_LOCKED = 0x07, /*!< \brief INIC performs already requested function. */
MNS_RET_ERR_NOT_INITIALIZED = 0x08 /*!< \brief MOST NetServices is not initialized */
} Mns_Return_t;
/*! \brief Result codes used for asynchronous response */
typedef enum Mns_Result_
{
MNS_RES_SUCCESS = 0x00, /*!< \brief Operation successfully completed */
MNS_RES_ERR_MOST_STANDARD = 0x01, /*!< \brief MOST standard error occurred */
MNS_RES_ERR_BUSY = 0x02, /*!< \brief Function currently busy */
MNS_RES_ERR_PROCESSING = 0x03, /*!< \brief Processing error occurred */
MNS_RES_ERR_CONFIGURATION = 0x04, /*!< \brief Configuration error occurred */
MNS_RES_ERR_SYSTEM = 0x05, /*!< \brief System error occurred */
MNS_RES_ERR_TIMEOUT = 0x06, /*!< \brief Timeout occurred */
MNS_RES_ERR_TRANSMISSION = 0x07 /*!< \brief Transmission error occurred */
} Mns_Result_t;
/*------------------------------------------------------------------------------------------------*/
/* Structures */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Standard result structure which provides fields for detailed status and
* error information
* \details \mns_ic_started{ The \ref P_UM_SYNC_AND_ASYNC_RESULTS section in \c Getting \c Started will provide you with more detailed information concerning the info pointer and the error code. }
*/
typedef struct Mns_StdResult_
{
Mns_Result_t code; /*!< \brief Result/Error code */
uint8_t *info_ptr; /*!< \brief INIC error data */
uint8_t info_size; /*!< \brief Size of the INIC error data in bytes */
} Mns_StdResult_t;
/*------------------------------------------------------------------------------------------------*/
/* Types */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Function signature used for MOST NetServices standard result callbacks
* \param result Result of the callback
*/
typedef void (*Mns_StdResultCb_t)(Mns_StdResult_t result);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* #ifndef MNS_RET_H */
/*!
* @}
*/
/*------------------------------------------------------------------------------------------------*/
/* End of file */
/*------------------------------------------------------------------------------------------------*/
|
