tmr_serial_transport.h

Go to the documentation of this file.

#ifndef _TMR_SERIAL_TRANSPORT_H
#define _TMR_SERIAL_TRANSPORT_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.
 */

#ifdef  __cplusplus
extern "C" {
#endif

#ifdef TMR_ENABLE_SERIAL_TRANSPORT_LLRP
#include <sys/types.h>
#include <sys/socket.h>
#endif

#ifdef WIN32
#include <windows.h>
#endif

#ifdef OSDEP_SERIAL_INCLUDE
#include "osdep_serial_transport.h"
#endif

#ifndef PLATFORM_HANDLE
# ifdef WIN32
#  define PLATFORM_HANDLE HANDLE
# else
#if defined(ARDUINO) || defined(FREERTOS_USED)
#   define PLATFORM_HANDLE void*
# else
#  define PLATFORM_HANDLE int
# endif
# endif
#endif
typedef struct TMR_SR_SerialTransport TMR_SR_SerialTransport;
struct TMR_SR_SerialTransport
{
  void *cookie;

  TMR_Status (*open)(TMR_SR_SerialTransport *);

  TMR_Status (*sendBytes)(TMR_SR_SerialTransport *, uint32_t length, 
                          uint8_t* message, const uint32_t timeoutMs);

  TMR_Status (*receiveBytes)(TMR_SR_SerialTransport *, uint32_t length,
                             uint32_t *messageLength, uint8_t* message, const uint32_t timeoutMs);
  TMR_Status (*setBaudRate)(TMR_SR_SerialTransport *, uint32_t rate);

  TMR_Status (*shutdown)(TMR_SR_SerialTransport *);

  TMR_Status (*flush)(TMR_SR_SerialTransport *);
};

#ifdef TMR_ENABLE_SERIAL_TRANSPORT_NATIVE

typedef struct TMR_SR_SerialPortNativeContext
{
  PLATFORM_HANDLE handle;
  char devicename[TMR_MAX_READER_NAME_LENGTH];
} TMR_SR_SerialPortNativeContext;
#endif

#ifdef TMR_ENABLE_SERIAL_TRANSPORT_LLRP

typedef struct TMR_SR_LlrpEapiTransportContext
{
  struct sockaddr_storage addr;
  socklen_t addrlen;
  bool powerCycleAtOpen;
  int socket;
  int sequenceId;
  uint8_t buf[270];
  uint16_t bufstart, buflen;
} TMR_SR_LlrpEapiTransportContext;
#endif

#ifdef TMR_ENABLE_SERIAL_TRANSPORT_NATIVE

#ifdef WIN32
__declspec(dllexport)
#endif
TMR_Status TMR_SR_SerialTransportNativeInit(TMR_SR_SerialTransport *transport,
                                            TMR_SR_SerialPortNativeContext *context,
                                            const char *device);
#ifdef WIN32
__declspec(dllexport)
#endif
TMR_Status TMR_SR_SerialTransportTcpNativeInit(TMR_SR_SerialTransport *transport,
                                            TMR_SR_SerialPortNativeContext *context,
                                            const char *device);
#endif /* TMR_ENABLE_SERIAL_TRANSPORT_NATIVE */

#ifdef TMR_ENABLE_SERIAL_TRANSPORT_LLRP

TMR_Status TMR_SR_LlrpEapiTransportInit(TMR_SR_SerialTransport *transport,
                                        TMR_SR_LlrpEapiTransportContext *context,
                                        const char *host, int port,
                                        bool powerCycleAtOpen);

TMR_Status TMR_LlrpEapiPowerCycle(TMR_SR_SerialTransport *this);
#endif

#ifdef __cplusplus
}
#endif

#endif /* _TMR_SERIAL_TRANSPORT_H */