/**
 * @file  rv_general.h
 *
 * Definitions that are shared between S/W entities
 * in the Riviera Environment.
 *
 * @author  David Lamy-Charrier (d-lamy@ti.com)
 * @version  0.1
 */

/*
 * Revision History:
 *
 *  Date         Author          Modification
 *  -------------------------------------------------------------------
 *  03/12/1999              Create.
 *  12/03/1999  Christian Livadiotti  Replaced:
 *                    #define ARRAY_TO_STREAM(p, a, l) {register int i; for
 *                    (i = 0; i < l; i++) *p++ = (UINT8) a[i];}
 *                    by the following to change convention of array writing.
 *  12/08/1999  Pascal Pompei      Add STREAM_TO_ARRAY
 *  11/20/2001  Vincent Oberle      - Changed T_RV_RETURN to T_RV_RETURN_PATH
 *                      Keep compatibility with a define
 *                    - Documentation cleaning
 *  06/03/2002  Vincent Oberle      Added __RV_CRITICAL
 *
 * (C) Copyright 2002 by Texas Instruments Incorporated, All Rights Reserved
 */
#ifndef _RV_GENERAL_H_
#define _RV_GENERAL_H_

#include "general.h"
#include "rv_trace.h"

/**
 * Task IDentifiers: A-M-E-N-D-E-D!
 *    0:                   Reserved for RVM,
 *    RVTEST_MENU_TASK_ID: 'Test Selection Menu',
 *    DUMMY_TASK_ID:       'Dummy' task.
 *    MAX - 1:             Trace task (refer to rvf_target.h).
 */
#define RVTEST_MENU_TASK_ID (0x0A)
#define DUMMY_TASK_ID (0x0B)

/**
 * Returned parameter values.  [Perhaps, a memory level WARNING could be added]  */
typedef enum {
  RV_OK = 0,
  RV_NOT_SUPPORTED = -2,
  RV_NOT_READY = -3,
  RV_MEMORY_WARNING = -4,
  RV_MEMORY_ERR = -5,
  RV_MEMORY_REMAINING = -6,
  RV_INTERNAL_ERR = -9,
  RV_INVALID_PARAMETER = -10,
  RV_NOT_INITIALISED = -51  
} T_RV_RET;

/**
 * Unique ADDRess IDentifier of any SWE. (T_RVF_ADDR_ID is deprecated)
 */
typedef UINT8 T_RVF_G_ADDR_ID;
#define T_RVF_ADDR_ID T_RVF_G_ADDR_ID

/**
 * Return path type.
 *
 * T_RV_RETURN_PATH is the new name for the return path type.
 * It is introduced to avoid the confusion with the return value
 * type. Use this one.
 */
typedef struct
{
  T_RVF_ADDR_ID addr_id;
  void (*callback_func)(void *);
} T_RV_RETURN_PATH;

// Deprecated. For backward compatibility only.
#define T_RV_RETURN T_RV_RETURN_PATH

/**
 * Mark used to indicate that a function should be loadable.
 * For instance:
 *    char __RV_CRITICAL xxx_do_something (char toto, int bill) {
 *        ..
 */
#ifndef __RV_CRITICAL
#define __RV_CRITICAL
#endif

/**
 * Generic header of messages used in Riviera.
 */
typedef struct {
    UINT32 msg_id;
  void (*callback_func)(void *);
    T_RVF_ADDR_ID src_addr_id;
  T_RVF_ADDR_ID dest_addr_id;
} T_RV_HDR;

#define RV_HDR_SIZE (sizeof (T_RV_HDR))

/**
 * Macros to get and put bytes to and from a stream (Little Endian format).
 */
#define UINT32_TO_STREAM(p, u32) {*(p)++ = (UINT8)(u32); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 24);}
#define UINT24_TO_STREAM(p, u24) {*(p)++ = (UINT8)(u24); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)((u24) >> 16);}
#define UINT16_TO_STREAM(p, u16) {*(p)++ = (UINT8)(u16); *(p)++ = (UINT8)((u16) >> 8);}
#define UINT8_TO_STREAM(p, u8) {*(p)++ = (UINT8)(u8);}

#define ARRAY_TO_STREAM(p, a, l) {register INT32 i; for (i = l-1; i >= 0; i--) *(p)++ = (UINT8) a[i];}

#define STREAM_TO_UINT8(u8, p) {u8 = *(p); (p) += 1;}
#define STREAM_TO_UINT16(u16, p) {u16 = (UINT16)(*(p) + (*((p) + 1) << 8)); (p) += 2;}
#define STREAM_TO_UINT32(u32, p) {u32 = (UINT32)(*(p) + (*((p) + 1) << 8) + (*((p) + 2) << 16) + (*((p) + 3) << 24)); (p) += 4;}

#define STREAM_TO_ARRAY(a, p, l) {register INT32 i; for (i = l-1; i >= 0; i--) a[i] = *(UINT8*)(p)++ ;}

/**
 * Macros to get and put bytes to and from a stream (Big Endian format).
 */
#define UINT32_TO_BE_STREAM(p, u32) {*(p)++ = (UINT8)((u32) >> 24); *(p)++ = (UINT8)((u32) >> 16); *(p)++ = (UINT8)((u32) >> 8); *(p)++ = (UINT8)(u32); }
#define UINT24_TO_BE_STREAM(p, u24) {*(p)++ = (UINT8)((u24) >> 16); *(p)++ = (UINT8)((u24) >> 8); *(p)++ = (UINT8)(u24);}
#define UINT16_TO_BE_STREAM(p, u16) {*(p)++ = (UINT8)((u16) >> 8); *(p)++ = (UINT8)(u16);}
#define UINT8_TO_BE_STREAM(p, u8) {*(p)++ = (UINT8)(u8);}

#define ARRAY_TO_BE_STREAM(p, a, l) {register INT32 i; for (i = 0; i < l; i++) *(p)++ = (UINT8) a[i];}

#define BE_STREAM_TO_UINT8(u8, p) {u8 = (UINT8)(*(p)); (p) += 1;}
#define BE_STREAM_TO_UINT16(u16, p) {u16 = (UINT16)(((*(p)) << 8) + (*((p) + 1))); (p) += 2;}
#define BE_STREAM_TO_UINT32(u32, p) {u32 = (UINT32)((*((p) + 3)) + ((*((p) + 2)) << 8) + ((*((p) + 1)) << 16) + ((*(p)) << 24)); (p) += 4;}
#define BE_STREAM_TO_ARRAY(a, p, l) {register INT32 i; for (i = 0; i < l; i++) a[i] = *(UINT8*)(p)++;}

/**
 * Macros to get minimum and maximum between 2 numbers.
 */
#define Min(a,b) ((a)<(b)?(a):(b))
#define Max(a,b) ((a)<(b)?(b):(a))

/**
 * Macro to get minimum between 3 numbers.
 */
#define Min3(a,b,c) (Min(Min(a,b),c))

/**
 * Common Bluetooth field definitions.
 */

// Device address.
#define BD_ADDR_LEN (6)
typedef UINT8 T_BD_ADDR[BD_ADDR_LEN];

// Link Key.
#define LINK_KEY_LEN (16)
typedef UINT8 T_LINK_KEY[LINK_KEY_LEN];

// Pin Code (upto 128 bits) MSB is 0.
#define PIN_CODE_LEN (16)
typedef UINT8 T_PIN_CODE[PIN_CODE_LEN];

// Class Of Device.
#define DEV_CLASS_LEN (3)
typedef UINT8 T_DEV_CLASS[DEV_CLASS_LEN];

// Device name.
#define BD_NAME_LEN (248)
typedef UINT8 T_BD_NAME[BD_NAME_LEN];

// Event Mask.
#define EVENT_MASK_LEN (8)
typedef UINT8 T_EVENT_MASK[EVENT_MASK_LEN];

// IAC as passed to Inquiry (LAP).
#define LAP_LEN (3)
typedef UINT8 T_LAP[LAP_LEN];
typedef UINT8 T_INQ_LAP[LAP_LEN];

#define RAND_NUM_LEN (16)
typedef UINT8 T_RAND_NUM[RAND_NUM_LEN];

// Authenticated ciphering offset.
#define ACO_LEN (12)
typedef UINT8 T_ACO[ACO_LEN];

// Ciphering offset number.
#define COF_LEN (12)
typedef UINT8 T_COF[COF_LEN];

// Pointer type used to handle received data that L2CAP set in a chained buffer list.
typedef UINT8 T_RV_BUFFER;

#endif /* _RV_GENERAL_H_ */