tmr_status.h

Go to the documentation of this file.

#ifndef _TMR_STATUS_H
#define _TMR_STATUS_H

 /*
 * Copyright (c) 2009 ThingMagic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "tm_config.h"
#include <stdint.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef uint32_t TMR_Status;

#define TMR_STATUS_MAKE(type, value) (((type) << 24) | (value))
#define TMR_STATUS_GET_TYPE(x)       (((x) >> 24) & 0xff)
#define TMR_STATUS_GET_VALUE(x)      ((x) & 0xffffff)

#define TMR_SUCCESS_TYPE    0L
#define TMR_ERROR_TYPE_COMM 1L
#define TMR_ERROR_TYPE_CODE 2L
#define TMR_ERROR_TYPE_MISC 3L
#define TMR_ERROR_TYPE_LLRP 4L

#define TMR_SUCCESS TMR_STATUS_MAKE(TMR_SUCCESS_TYPE, 0)

#define TMR_ERROR_CODE(x)     TMR_STATUS_MAKE(TMR_ERROR_TYPE_CODE, (x))
#define TMR_ERROR_IS_CODE(x)  (TMR_ERROR_TYPE_CODE == TMR_STATUS_GET_TYPE(x))
#define TMR_ERROR_GET_CODE(x) TMR_STATUS_GET_VALUE(x)

#define TMR_ERROR_MSG_WRONG_NUMBER_OF_DATA                TMR_ERROR_CODE(0x100)

#define TMR_ERROR_INVALID_OPCODE                          TMR_ERROR_CODE(0x101)

#define TMR_ERROR_UNIMPLEMENTED_OPCODE                    TMR_ERROR_CODE(0x102)

#define TMR_ERROR_MSG_POWER_TOO_HIGH                      TMR_ERROR_CODE(0x103)

#define TMR_ERROR_MSG_INVALID_FREQ_RECEIVED               TMR_ERROR_CODE(0x104)

#define TMR_ERROR_MSG_INVALID_PARAMETER_VALUE             TMR_ERROR_CODE(0x105)

#define TMR_ERROR_MSG_POWER_TOO_LOW                       TMR_ERROR_CODE(0x106)

#define TMR_ERROR_UNIMPLEMENTED_FEATURE                   TMR_ERROR_CODE(0x109)

#define TMR_ERROR_INVALID_BAUD_RATE                       TMR_ERROR_CODE(0x10a)

#define TMR_ERROR_INVALID_REGION                          TMR_ERROR_CODE(0x10b)

#define TMR_ERROR_INVALID_LICENSE_KEY                     TMR_ERROR_CODE(0x10c)

#define TMR_ERROR_BL_INVALID_IMAGE_CRC                    TMR_ERROR_CODE(0x200)

#define TMR_ERROR_BL_INVALID_APP_END_ADDR                 TMR_ERROR_CODE(0x201)

#define TMR_ERROR_FLASH_BAD_ERASE_PASSWORD                TMR_ERROR_CODE(0x300)

#define TMR_ERROR_FLASH_BAD_WRITE_PASSWORD                TMR_ERROR_CODE(0x301)

#define TMR_ERROR_FLASH_UNDEFINED_SECTOR                  TMR_ERROR_CODE(0x302)

#define TMR_ERROR_FLASH_ILLEGAL_SECTOR                    TMR_ERROR_CODE(0x303)

#define TMR_ERROR_FLASH_WRITE_TO_NON_ERASED_AREA          TMR_ERROR_CODE(0x304)

#define TMR_ERROR_FLASH_WRITE_TO_ILLEGAL_SECTOR           TMR_ERROR_CODE(0x305)

#define TMR_ERROR_FLASH_VERIFY_FAILED                     TMR_ERROR_CODE(0x306)

#define TMR_ERROR_NO_TAGS_FOUND                           TMR_ERROR_CODE(0x400)

#define TMR_ERROR_NO_PROTOCOL_DEFINED                     TMR_ERROR_CODE(0x401)

#define TMR_ERROR_INVALID_PROTOCOL_SPECIFIED              TMR_ERROR_CODE(0x402)

#define TMR_ERROR_WRITE_PASSED_LOCK_FAILED                TMR_ERROR_CODE(0x403)

#define TMR_ERROR_PROTOCOL_NO_DATA_READ                   TMR_ERROR_CODE(0x404)

#define TMR_ERROR_AFE_NOT_ON                              TMR_ERROR_CODE(0x405)

#define TMR_ERROR_PROTOCOL_WRITE_FAILED                   TMR_ERROR_CODE(0x406)

#define TMR_ERROR_NOT_IMPLEMENTED_FOR_THIS_PROTOCOL       TMR_ERROR_CODE(0x407)

#define TMR_ERROR_PROTOCOL_INVALID_WRITE_DATA             TMR_ERROR_CODE(0x408)

#define TMR_ERROR_PROTOCOL_INVALID_ADDRESS                TMR_ERROR_CODE(0x409)

#define TMR_ERROR_GENERAL_TAG_ERROR                       TMR_ERROR_CODE(0x40a)

#define TMR_ERROR_DATA_TOO_LARGE                          TMR_ERROR_CODE(0x40b)

#define TMR_ERROR_PROTOCOL_INVALID_KILL_PASSWORD          TMR_ERROR_CODE(0x40c)

#define TMR_ERROR_PROTOCOL_KILL_FAILED                    TMR_ERROR_CODE(0x40e)

#define TMR_ERROR_PROTOCOL_BIT_DECODING_FAILED            TMR_ERROR_CODE(0x40f)

#define TMR_ERROR_PROTOCOL_INVALID_EPC                    TMR_ERROR_CODE(0x410)

#define TMR_ERROR_PROTOCOL_INVALID_NUM_DATA               TMR_ERROR_CODE(0x411)

#define TMR_ERROR_GEN2_PROTOCOL_OTHER_ERROR               TMR_ERROR_CODE(0x420)

#define TMR_ERROR_GEN2_PROTOCOL_MEMORY_OVERRUN_BAD_PC     TMR_ERROR_CODE(0x423)

#define TMR_ERROR_GEN2_PROCOCOL_MEMORY_LOCKED             TMR_ERROR_CODE(0x424)

#define TMR_ERROR_GEN2_PROTOCOL_V2_AUTHEN_FAILED                                TMR_ERROR_CODE(0x425)

#define TMR_ERROR_GEN2_PROTOCOL_V2_UNTRACE_FAILED                               TMR_ERROR_CODE(0x426)

#define TMR_ERROR_GEN2_PROTOCOL_INSUFFICIENT_POWER        TMR_ERROR_CODE(0x42b)

#define TMR_ERROR_GEN2_PROTOCOL_NON_SPECIFIC_ERROR        TMR_ERROR_CODE(0x42f)

#define TMR_ERROR_GEN2_PROTOCOL_UNKNOWN_ERROR             TMR_ERROR_CODE(0x430)

#define TMR_ERROR_AHAL_INVALID_FREQ                       TMR_ERROR_CODE(0x500)

#define TMR_ERROR_AHAL_CHANNEL_OCCUPIED                   TMR_ERROR_CODE(0x501)

#define TMR_ERROR_AHAL_TRANSMITTER_ON                     TMR_ERROR_CODE(0x502)

#define TMR_ERROR_ANTENNA_NOT_CONNECTED                   TMR_ERROR_CODE(0x503)

#define TMR_ERROR_TEMPERATURE_EXCEED_LIMITS               TMR_ERROR_CODE(0x504)

#define TMR_ERROR_HIGH_RETURN_LOSS                        TMR_ERROR_CODE(0x505)
#define TMR_ERROR_INVALID_ANTENNA_CONFIG                  TMR_ERROR_CODE(0x507)

#define TMR_ERROR_TAG_ID_BUFFER_NOT_ENOUGH_TAGS_AVAILABLE TMR_ERROR_CODE(0x600)

#define TMR_ERROR_TAG_ID_BUFFER_FULL                      TMR_ERROR_CODE(0x601)

#define TMR_ERROR_TAG_ID_BUFFER_REPEATED_TAG_ID           TMR_ERROR_CODE(0x602)

#define TMR_ERROR_TAG_ID_BUFFER_NUM_TAG_TOO_LARGE         TMR_ERROR_CODE(0x603)

#define TMR_ERROR_TAG_ID_BUFFER_AUTH_REQUEST              TMR_ERROR_CODE(0x604)

#define TMR_ERROR_SYSTEM_UNKNOWN_ERROR                    TMR_ERROR_CODE(0x7f00)

#define TMR_ERROR_TM_ASSERT_FAILED                        TMR_ERROR_CODE(0x7f01)

#define TMR_ERROR_COMM(x)           TMR_STATUS_MAKE(TMR_ERROR_TYPE_COMM, (x))
#define TMR_ERROR_IS_COMM(x)        (TMR_ERROR_TYPE_COMM == TMR_STATUS_GET_TYPE(x))
#define TMR_ERROR_COMM_ERRNO(x)     TMR_ERROR_COMM(0x8000 | (x))
#define TMR_ERROR_COMM_IS_ERRNO(x)  (0x8000 == (TMR_STATUS_GET_VALUE(x) & 0x8000))
#define TMR_ERROR_COMM_GET_ERRNO(x) (TMR_STATUS_GET_VALUE(x) & 0x7fff)
#define TMR_ERROR_TIMEOUT           TMR_ERROR_COMM(1)
#define TMR_ERROR_NO_HOST           TMR_ERROR_COMM(2)
#define TMR_ERROR_LLRP              TMR_ERROR_COMM(3)
#define TMR_ERROR_PARSE             TMR_ERROR_COMM(4)
#define TMR_ERROR_DEVICE_RESET      TMR_ERROR_COMM(5)
#define TMR_ERROR_CRC_ERROR         TMR_ERROR_COMM(6)

#define TMR_ERROR_MISC(x)  TMR_STATUS_MAKE(TMR_ERROR_TYPE_MISC, (x))
#define TMR_ERROR_INVALID          TMR_ERROR_MISC(1)
#define TMR_ERROR_UNIMPLEMENTED    TMR_ERROR_MISC(2)
#define TMR_ERROR_UNSUPPORTED      TMR_ERROR_MISC(3)
#define TMR_ERROR_NO_ANTENNA       TMR_ERROR_MISC(4)
#define TMR_ERROR_READONLY         TMR_ERROR_MISC(5)
#define TMR_ERROR_TOO_BIG          TMR_ERROR_MISC(6)
#define TMR_ERROR_NO_THREADS       TMR_ERROR_MISC(7)
#define TMR_ERROR_NO_TAGS          TMR_ERROR_MISC(8)
#define TMR_ERROR_NOT_FOUND        TMR_ERROR_MISC(9)
#define TMR_ERROR_FIRMWARE_FORMAT  TMR_ERROR_MISC(10)
#define TMR_ERROR_TRYAGAIN         TMR_ERROR_MISC(11)
#define TMR_ERROR_OUT_OF_MEMORY    TMR_ERROR_MISC(12)
#define TMR_ERROR_INVALID_WRITE_MODE  TMR_ERROR_MISC(13)
#define TMR_ERROR_ILLEGAL_VALUE    TMR_ERROR_MISC(14)
#define TMR_ERROR_END_OF_READING         TMR_ERROR_MISC(15)
#define TMR_ERROR_UNSUPPORTED_READER_TYPE  TMR_ERROR_MISC(16)
#define TMR_ERROR_BUFFER_OVERFLOW  TMR_ERROR_MISC(17)
#define TMR_ERROR_LOADSAVE_CONFIG  TMR_ERROR_MISC(18)
#define TMR_ERROR_AUTOREAD_ENABLED TMR_ERROR_MISC(19)
#define TMR_ERROR_FIRMWARE_UPDATE_ON_AUTOREAD  TMR_ERROR_MISC(20)
#define TMR_ERROR_TIMESTAMP_NULL  TMR_ERROR_MISC(21)

/* LLRP related errors */
#define TMR_ERROR_LLRP_SPECIFIC(x)            TMR_STATUS_MAKE(TMR_ERROR_TYPE_LLRP, (x))
#define TMR_ERROR_IS_LLRP_SPECIFIC(x)         (TMR_ERROR_TYPE_LLRP == TMR_STATUS_GET_TYPE(x))
#define TMR_ERROR_LLRP_GETTYPEREGISTRY        TMR_ERROR_LLRP_SPECIFIC(1)
#define TMR_ERROR_LLRP_CONNECTIONFAILED       TMR_ERROR_LLRP_SPECIFIC(2)
#define TMR_ERROR_LLRP_SENDIO_ERROR           TMR_ERROR_LLRP_SPECIFIC(3)
#define TMR_ERROR_LLRP_RECEIVEIO_ERROR        TMR_ERROR_LLRP_SPECIFIC(4)
#define TMR_ERROR_LLRP_RECEIVE_TIMEOUT        TMR_ERROR_LLRP_SPECIFIC(5)
#define TMR_ERROR_LLRP_MSG_PARSE_ERROR        TMR_ERROR_LLRP_SPECIFIC(6)
#define TMR_ERROR_LLRP_ALREADY_CONNECTED      TMR_ERROR_LLRP_SPECIFIC(7)
#define TMR_ERROR_LLRP_INVALID_RFMODE         TMR_ERROR_LLRP_SPECIFIC(8)
#define TMR_ERROR_LLRP_UNDEFINED_VALUE        TMR_ERROR_LLRP_SPECIFIC(9)
#define TMR_ERROR_LLRP_READER_ERROR           TMR_ERROR_LLRP_SPECIFIC(10)
#define TMR_ERROR_LLRP_READER_CONNECTION_LOST TMR_ERROR_LLRP_SPECIFIC(11)

#ifdef TMR_ENABLE_ERROR_STRINGS
const char *TMR_strerror(TMR_Status status);
#endif

#ifdef __cplusplus
}
#endif

#endif /* _TMR_STATUS_H */