252 lines
8.6 KiB
C
252 lines
8.6 KiB
C
|
/**************************************************************************************************
|
|||
|
|
Filename: reflecttrack.h
|
|||
|
|
Revised: $Date: 2009-03-12 16:25:22 -0700 (Thu, 12 Mar 2009) $
|
|||
|
|
Revision: $Revision: 19404 $
|
|||
|
|
|
|||
|
|
Description: APS Reflect Tracking Database Module
|
|||
|
|
|
|||
|
|
|
|||
|
|
Copyright 2005-2007 Texas Instruments Incorporated. All rights reserved.
|
|||
|
|
|
|||
|
|
IMPORTANT: Your use of this Software is limited to those specific rights
|
|||
|
|
granted under the terms of a software license agreement between the user
|
|||
|
|
who downloaded the software, his/her employer (which must be your employer)
|
|||
|
|
and Texas Instruments Incorporated (the "License"). You may not use this
|
|||
|
|
Software unless you agree to abide by the terms of the License. The License
|
|||
|
|
limits your use, and you acknowledge, that the Software may not be modified,
|
|||
|
|
copied or distributed unless embedded on a Texas Instruments microcontroller
|
|||
|
|
or used solely and exclusively in conjunction with a Texas Instruments radio
|
|||
|
|
frequency transceiver, which is integrated into your product. Other than for
|
|||
|
|
the foregoing purpose, you may not use, reproduce, copy, prepare derivative
|
|||
|
|
works of, modify, distribute, perform, display or sell this Software and/or
|
|||
|
|
its documentation for any purpose.
|
|||
|
|
|
|||
|
|
YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
|
|||
|
|
PROVIDED <EFBFBD>AS IS<EFBFBD> WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
|||
|
|
INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
|
|||
|
|
NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
|
|||
|
|
TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
|
|||
|
|
NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
|
|||
|
|
LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
|
|||
|
|
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
|
|||
|
|
OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
|
|||
|
|
OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
|
|||
|
|
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
|
|||
|
|
|
|||
|
|
Should you have any questions regarding your right to use this Software,
|
|||
|
|
contact Texas Instruments Incorporated at www.TI.com.
|
|||
|
|
**************************************************************************************************/
|
|||
|
|
|
|||
|
|
#ifndef REFLECTTRACK_H
|
|||
|
|
#define REFLECTTRACK_H
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
extern "C" {
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* INCLUDES
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#include "ZComdef.h"
|
|||
|
|
#include "osal.h"
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* MACROS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* CONSTANTS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
// This is the default number of max entries. If you would like to
|
|||
|
|
// change this value, DON'T change this constant - call
|
|||
|
|
// reflectTracking_SetMaxEntries() instead.
|
|||
|
|
#define REFTRACK_MAX_ENTRIES 5
|
|||
|
|
|
|||
|
|
// This is the maximum number of simultaneous messages sent for a reflection.
|
|||
|
|
// For example if a message is to be reflected to 10 devices, this constant
|
|||
|
|
// restricts the number of messages that are currently being sent, the others
|
|||
|
|
// wait for the simultaneous messages to complete. If you would like to
|
|||
|
|
// change this value, DON'T change this constant - call
|
|||
|
|
// reflectTracking_SetMaxSimultaneous() instead.
|
|||
|
|
#define REFTRACK_MAX_SIMUL 3
|
|||
|
|
|
|||
|
|
// This is the maximum number of indirect messages of REFTRACK_MAX_SIMUL.
|
|||
|
|
// If you would like to change this value, DON'T change this constant - call
|
|||
|
|
// reflectTracking_SetMaxIndirect() instead. The parameter can't be
|
|||
|
|
// larger than REFTRACK_MAX_SIMUL
|
|||
|
|
#define REFTRACK_MAX_INDIRECTS 1
|
|||
|
|
|
|||
|
|
// ReflectDestRec_t options
|
|||
|
|
#define REFDEST_WAITING 0x00
|
|||
|
|
#define REFDEST_SENT 0x01
|
|||
|
|
#define REFDEST_APS_ACK_EXPECTED 0x02
|
|||
|
|
#define REFDEST_DELIVERED 0x04
|
|||
|
|
#define REFDEST_FAILED 0x08
|
|||
|
|
#define REFDEST_INDIRECT 0x80
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* TYPEDEFS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
typedef struct
|
|||
|
|
{
|
|||
|
|
uint8 dstAddrMode; // 0 - normal short addr, 1 - group Address
|
|||
|
|
uint16 dstAddr; // depends on dstAddrMode
|
|||
|
|
uint8 dstEP;
|
|||
|
|
uint8 handle;
|
|||
|
|
uint8 options;
|
|||
|
|
} ReflectDestRec_t;
|
|||
|
|
|
|||
|
|
typedef struct
|
|||
|
|
{
|
|||
|
|
void *next; // Next in the link List
|
|||
|
|
uint8 ID; // Unique ID
|
|||
|
|
uint8 srcEP;
|
|||
|
|
uint16 clusterID;
|
|||
|
|
uint8 confirmed;
|
|||
|
|
uint16 transID;
|
|||
|
|
uint8* asdu; // saved asdu
|
|||
|
|
uint8 numdests; // number of the destination reflections
|
|||
|
|
ReflectDestRec_t dests[]; // Arrary of destinations
|
|||
|
|
// - the number of destinations must
|
|||
|
|
// be used to allocate this element
|
|||
|
|
} ReflectTracking_t;
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* GLOBAL VARIABLES
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* FUNCTIONS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Set the Maximum number of tracking entries. This is also the
|
|||
|
|
* number of simultaneous reflections that can occur. Also, if you
|
|||
|
|
* would like to keep a history, make this value more than you need.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTrack_SetMaxEntries( uint8 newEntries );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Set a new maximum for the maximum number of simultaneous
|
|||
|
|
* messages sent for a reflection. For example if a message
|
|||
|
|
* is to be reflected to 10 devices, this constant restricts
|
|||
|
|
* the number of messages that are currently being sent, the
|
|||
|
|
* others wait for the simultaneous messages to complete.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTracking_SetMaxSimultaneous( uint8 newEntries );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Get the number of simultaneous bufs.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTracking_GetMaxSimultaneous( void );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Get the number of simultaneous bufs adjusted for the
|
|||
|
|
* number of bufs already sent.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTracking_GetMaxSimultaneousAdjusted( ReflectTracking_t *entry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Set a new maximum for the maximum number of indirect
|
|||
|
|
* messages of REFTRACK_MAX_SIMUL.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTracking_SetMaxIndirect( uint8 newEntries );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Get a new maximum for the maximum number of indirect
|
|||
|
|
* messages.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTracking_GetMaxIndirect( void );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Get a new maximum for the maximum number of indirect
|
|||
|
|
* messages adjusted for the number being sent.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTracking_GetMaxIndirectAdjusted( ReflectTracking_t *entry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Gets a memory block for a reflect tracking entry. This doesn't add
|
|||
|
|
* to the list. It just gets the memory, you must fill in and add to
|
|||
|
|
* the list by calling
|
|||
|
|
*/
|
|||
|
|
extern ReflectTracking_t *reflectTrack_GetNewEntry( uint8 numDests,
|
|||
|
|
uint8 asduLen );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Get the number of entries currently in the list.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTrack_NumEntries( void );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Remove an entry from the list and release its memory.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTrack_RemoveEntry( ReflectTracking_t *entry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Stub for notifying user of entry deletion
|
|||
|
|
*/
|
|||
|
|
extern void reflectTrack_RemoveEntryNotify( ReflectTracking_t *entry);
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Add this entry to the end of the list.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTrack_AddToEnd( ReflectTracking_t *entry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Add entry to the list. It will add to the end of the list.
|
|||
|
|
* if the list is full, the first entry will be deleted.
|
|||
|
|
* returns the unique reflect ID
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTrack_AddNewEntry( ReflectTracking_t *newEntry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Find entry in list based on the reflectID returned
|
|||
|
|
* from the call to reflectTrack_AddNewEntry().
|
|||
|
|
*/
|
|||
|
|
extern ReflectTracking_t *reflectTrack_FindEntry( byte refID );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Find entry in list based on the handle returned
|
|||
|
|
* from the call to reflectTrack_AddNewEntry().
|
|||
|
|
*/
|
|||
|
|
extern ReflectTracking_t *reflectTrack_FindHandle( byte handle );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Update (OR in) options for the passed in parameters.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTrack_UpdateOption( ReflectTracking_t *ref, byte handle, byte option );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Find entry in list based on the source address, endpoint,
|
|||
|
|
* and clusterID.
|
|||
|
|
*/
|
|||
|
|
extern ReflectTracking_t *reflectTrack_FindEntryStatus( uint8 endpoint, uint16 clusterID );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Returns the number of reflections completed.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTracking_GetNumDelivered( ReflectTracking_t *entry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Returns the number of reflections failed.
|
|||
|
|
*/
|
|||
|
|
extern uint8 reflectTracking_GetNumFailed( ReflectTracking_t *entry );
|
|||
|
|
|
|||
|
|
/*
|
|||
|
|
* Fills in an array of failed short addresses.
|
|||
|
|
*/
|
|||
|
|
extern void reflectTracking_FillInFailed( ReflectTracking_t *entry, uint16 *list );
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
*********************************************************************/
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
}
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
#endif /* REFLECTTRACK_H */
|
|||
|
|
|
|||
|
|
|