/*
|
* Licensed to the Apache Software Foundation (ASF) under one
|
* or more contributor license agreements. See the NOTICE file
|
* distributed with this work for additional information
|
* regarding copyright ownership. The ASF licenses this file
|
* to you under the Apache License, Version 2.0 (the
|
* "License"); you may not use this file except in compliance
|
* with the License. You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing,
|
* software distributed under the License is distributed on an
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
* KIND, either express or implied. See the License for the
|
* specific language governing permissions and limitations
|
* under the License.
|
*/
|
|
#ifndef H_OS_ERROR_
|
#define H_OS_ERROR_
|
|
#include "os/os.h"
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
/* OS error enumerations */
|
enum os_error {
|
OS_OK = 0,
|
OS_ENOMEM = 1,
|
OS_EINVAL = 2,
|
OS_INVALID_PARM = 3,
|
OS_MEM_NOT_ALIGNED = 4,
|
OS_BAD_MUTEX = 5,
|
OS_TIMEOUT = 6,
|
OS_ERR_IN_ISR = 7, /* Function cannot be called from ISR */
|
OS_ERR_PRIV = 8, /* Privileged access error */
|
OS_NOT_STARTED = 9, /* OS must be started to call this function, but isn't */
|
OS_ENOENT = 10, /* No such thing */
|
OS_EBUSY = 11, /* Resource busy */
|
OS_ERROR = 12, /* Generic Error */
|
};
|
|
typedef enum os_error os_error_t;
|
|
/**
|
* @brief Converts an OS error code (`OS_[...]`) to an equivalent system error
|
* code (`SYS_E[...]`).
|
*
|
* @param os_error The OS error code to convert.
|
*
|
* @return The equivalent system error code.
|
*/
|
int os_error_to_sys(os_error_t os_error);
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif
|
