/*
 *  file  rm_nameserverloc.h
 *
 *  Prototypes and data structures for the Resource Manager NameServer.
 *
 *  ============================================================================
 *      (C) Copyright 2012, Texas Instruments, Inc.
 * 
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright 
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the 
 *    documentation and/or other materials provided with the   
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *  \par
*/

#ifndef RM_NAMESERVERLOC_H_
#define RM_NAMESERVERLOC_H_

#ifdef __cplusplus
extern "C" {
#endif

/* RM external includes */
#include <ti/drv/rm/rm.h>

/* RM internal includes */
#include <ti/drv/rm/include/rm_loc.h>

/* AVL BBST includes */
#include <ti/drv/rm/include/tree.h>

#define RM_NS_ACTION_APPROVED 0
#define RM_NS_OBJECT_FOUND 1
#define RM_NS_OBJECT_NOT_FOUND 2

#define RM_NS_ACTION_DENIED -1
#define RM_NS_ERROR_NAME_ALREADY_EXISTS -2
#define RM_NS_ERROR_NAME_DOES_NOT_EXIST -3

int32_t Rm_nsInit(Rm_Inst *rmInst);
int32_t Rm_nsAddObject(Rm_Inst *rmInst, Rm_ResourceInfo *resourceInfo);
int32_t Rm_nsFindObject(Rm_Inst *rmInst, Rm_ResourceInfo *resourceInfo);
int32_t Rm_nsDeleteObject(Rm_Inst *rmInst, Rm_ResourceInfo *resourceInfo);

/**********************************************************************
 ******************* Red-Black Tree BBST Defines **********************
 **********************************************************************/

/* Declare the tree structure nodes */
typedef struct _Rm_NameServerNode {
    RB_ENTRY(_Rm_NameServerNode) linkage;
    char name[RM_RESOURCE_NAME_MAX_CHARS];
    uint32_t base;
    uint32_t length;
} Rm_NameServerNode;

/* Declare the tree head structure. */
typedef RB_HEAD(_Rm_NameServerTree, _Rm_NameServerNode) Rm_NameServerTree;

Rm_NameServerNode *Rm_newNameServerNode(char *name, uint32_t resourceBase, 
                                        uint32_t resourceLength);
void Rm_freeNameServerNode(Rm_NameServerNode *node);
/* Prototype for NameServer node comparison function
 * element1 < element2 --> return < 0
 * element1 = element2 --> return 0
 * element1 > element2 --> return > 0 */
int Rm_NameServerNodeCompare(Rm_NameServerNode *element1, Rm_NameServerNode *element2); 

/* Generate the tree prototypes */
RB_PROTOTYPE(_Rm_NameServerTree, _Rm_NameServerNode, linkage, Rm_NameServerNodeCompare);

#ifdef __cplusplus
}
#endif

#endif /* RM_NAMESERVERLOC_H_ */