tmr_read_plan.h

Go to the documentation of this file.

/* ex: set tabstop=2 shiftwidth=2 expandtab cindent: */
#ifndef _TMR_READ_PLAN_H
#define _TMR_READ_PLAN_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 "tmr_tag_protocol.h"
#include "tmr_filter.h"
#include "tmr_tagop.h"

#ifdef  __cplusplus
extern "C" {
#endif


typedef struct TMR_ReadPlan TMR_ReadPlan;
typedef struct TMR_SimpleReadPlan TMR_SimpleReadPlan;
typedef struct TMR_MultiReadPlan TMR_MultiReadPlan;
typedef struct TMR_StopOnTagCount TMR_StopOnTagCount;
typedef struct TMR_TagObservationTrigger TMR_TagObservationTrigger;
typedef struct TMR_StopTrigger TMR_StopTrigger;
typedef struct TMR_GPITriggerRead TMR_GPITriggerRead;

/*struct TMR_TagObservationTrigger
{
};

struct TMR_StopTrigger
{
  TMR_TagObservationTrigger stopTrigger; 
};*/

struct TMR_StopOnTagCount
{
  /* option for stop N trigger */
  bool stopNTriggerStatus;

  /* Number of tags to be read */
  uint32_t noOfTags;
};

struct TMR_GPITriggerRead
{
  /* option for trigger read */
  bool enable;
  /* RFU - The list of GPI ports */
  TMR_uint8List gpiList;
};

struct TMR_SimpleReadPlan
{
  TMR_uint8List antennas;
  TMR_TagProtocol protocol;
  TMR_TagFilter *filter;
  TMR_TagOp *tagop;
  bool useFastSearch;
  TMR_StopOnTagCount stopOnCount;
  TMR_GPITriggerRead triggerRead;
};

struct TMR_MultiReadPlan
{
  TMR_ReadPlan **plans;
  uint32_t totalWeight; 
  uint8_t planCount;
};

typedef enum TMR_ReadPlanType
{
  TMR_READ_PLAN_TYPE_INVALID,
  TMR_READ_PLAN_TYPE_SIMPLE,
  TMR_READ_PLAN_TYPE_MULTI
} TMR_ReadPlanType;

struct TMR_ReadPlan
{
  TMR_ReadPlanType type;
  uint32_t weight;
  bool enableAutonomousRead;
  union
  {
    TMR_SimpleReadPlan simple;
    TMR_MultiReadPlan multi;
  } u;
};

TMR_Status TMR_RP_init_simple(TMR_ReadPlan *plan, uint8_t antennaCount,
                              uint8_t *antennaList, TMR_TagProtocol protocol,
                              uint32_t weight);

TMR_Status TMR_RP_init_multi(TMR_ReadPlan *plan, TMR_ReadPlan **plans,
                             uint8_t planCount, uint32_t weight);

TMR_Status TMR_GPITR_init_enable(TMR_GPITriggerRead *triggerRead, bool enable);

TMR_Status TMR_RP_set_filter(TMR_ReadPlan *plan, TMR_TagFilter *filter);

TMR_Status TMR_RP_set_tagop(TMR_ReadPlan *plan, TMR_TagOp *tagop);
TMR_Status TMR_RP_set_enableTriggerRead(TMR_ReadPlan *plan, TMR_GPITriggerRead *triggerRead);

TMR_Status TMR_RP_set_useFastSearch(TMR_ReadPlan *plan, bool useFastSearch);
TMR_Status TMR_RP_set_stopTrigger(TMR_ReadPlan *plan, uint32_t count);
TMR_Status TMR_RP_set_enableAutonomousRead(TMR_ReadPlan *plan, bool autonomousRead);
#ifdef  __cplusplus
}
#endif

#endif /* _TMR_READ_PLAN_H_ */