td_dsc_bus_limits.h

Motorola synergy audio component

#ifndef TD_DSC_BUS_LIMITS_INCLUDE
#define TD_DSC_BUS_LIMITS_INCLUDE

#ifdef __cplusplus        /* Allow # include in a C++ File          */
extern "C" {
#endif

/* (c) Copyright Motorola 1990, 1991 All rights reserved.               
   Motorola Confidential Proprietary                                    
   Contains Confidential Proprietary information of Motorola, Inc.      
   Reverse engineering is prohibited.                                   
   The copyright notice does not imply publication.                     


   DESCRIPTION:
       Some BIC definitions.                                                                        

**************************************** REVISION HISTORY *****************************************

     Date        Author      Reference Number
     ========    ========    ================
     98-10-06    mgilot      PR - CSGce22921
                 Whitecap Warmplug does not work in a Call
                 - Added constant BIC_DSC_ARBITRATION_COMPLETE

     98-09-08    dmuehl      PR - CSGce18312
                 Internal Data Integration Branch
 
     98-08-19    dmuehl      PR - CSGce20623
                 SCI Internal Data
                 Add support for SCI IP's, namely the data cable for internal data stage 2.
  
     98-02-15    gswanson    PR - CSGce12607
                 Add DAI support
                 - added #defines for DAI timeslot allocation type and 2 timeslot data 
                   allocation types
                 - updated some to coding standard

     97-04-10    dmuehl      PR - CSGce08550  
                 - No changes made. This version is simply an
                   integration branch to allow all warmplug/seamless PR's 
                   to be pulled into other products.               

     97-01-25    dmuehl      PR - CSGce05862
                 - Added defines for warmplug so that the bic_startup could be called with a parameter.  
                 
*/


/************** HEADER FILE INCLUDES ******************************************/
          
/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/

/************** FUNCTION PROTOTYPES *******************************************/

/************** MACROS ********************************************************/

/************** CLASS DEFINITIONS *********************************************/

/************** GLOBAL VARIABLES **********************************************/

/************** CONSTANTS *****************************************************/

/*******************************************************************
 * Miscellaneous constants
 *
 *******************************************************************/

 /* maximum number of times we will attempt to write to a perihperals control
  * register with out receiving a matching echo before we power down the phone.
  */
#define BIC_MAX_BCR_WRITE_ATTEMPTS     3

 
 /* This value is returned by the bic_get_attached_devices_cnf primitive
  * When all devices on the bus are ready and therefore it is not necessary to wait.  
  */
#define DSC_BUS_NO_RETRY_WAIT          0xFFFF
                                                          
                                                          
 /* The maximum allowable priority for a primitive on the DSC Bus.
  * DSC Frames received with a higher priority indicate a serious hardware problem 
  */
#define DSC_BUS_MAX_PRIMITIVE_PRIORITY 253 



/*******************************************************************
 * Warmplug/DSC bus startup stuff for the BIC task.
 *
 *******************************************************************/

#define BIC_DSC_ARBITRATION_COMPLETE   0xff 

 /* indicates a normal cold startup sequence */
#define BIC_DSC_POWER_UP_STARTUP_TYPE  0

 /* indicates a warm plug startup sequence */
#define BIC_DSC_WARM_PLUG_STARTUP_TYPE 1

/*   Values used as arguments for BIC reinitializing functions */
#define REMOVAL_INIT  0
 
#define POWERUP_INIT  1


/*******************************************************************
 * Limits on the number of peripherals and their DSC addresses.
 *
 *******************************************************************/
 /* The maximum number of peripherals on the DSC bus */
#define BIC_MAX_NUMBER_OF_DSC_PERIPHERALS    7

 /* The maximum number of intelligent peripherals on the SCI bus, this should never get bigger than 2 */
#define BIC_MAX_NUMBER_OF_SCI_PERIPHERALS    2

 /* 
    The total number of peripherals allowed, both DSC and SCI. Currently the 
    assumption is that we can't have both types simultaneously, so the true 
    max is the biggest # of the two (i.e. BIC_MAX_NUMBER_OF_DSC_PERIPHERALS).
    But there's no guarantee that this will be a restriction in the future so
    we'll add them to get the max #.
 */
#define BIC_MAX_NUMBER_OF_PERIPHERALS        (BIC_MAX_NUMBER_OF_DSC_PERIPHERALS + BIC_MAX_NUMBER_OF_SCI_PERIPHERALS)

 /* the real DSC addresses used for DSC devices */ 
#define BIC_FIRST_DSC_ADDR                   1
#define BIC_LAST_DSC_ADDR                    BIC_MAX_NUMBER_OF_DSC_PERIPHERALS

 /* the logical DSC addresses used for SCI intelligent devices */ 
#define BIC_FIRST_SCI_DSC_ADDR               (BIC_LAST_DSC_ADDR + 1)
#define BIC_LAST_SCI_DSC_ADDR                (BIC_LAST_DSC_ADDR + BIC_MAX_NUMBER_OF_SCI_PERIPHERALS)

 /* Invalid dsc bus address, returned when no dsc addresses are available */
#define BIC_INVALID_DSC_BUS_ADDRESS          0x0f

 /* Address of the DSC bit bucket. Same as BIC_INVALID_DSC_BUS_ADDRESS */
#define NONEXISTENT_DSC_BUS_ADDR             BIC_INVALID_DSC_BUS_ADDRESS

 /* logical DSC bus address of Call Processor */
#define DSC_BUS_CALL_PROCESSOR_ADDRESS       0x0e

 /* The number of intelligent peripherals that can be attached to the DSC bus  */
#define TD_MAX_NUM_MMIS       7

  /* The maximum number of handsets that can be attached to the DSC bus */
#define DSC_BUS_MAX_HANDSETS  5



/*******************************************************************
 * Limits on the DSC bus' physical channel (i.e. timeslots, frames,
 * bus speed etc.)
 *
 *******************************************************************/
 
 /* The max number of actual data bytes in a DSC bus block; 
  * i.e. max 8 frames (timeslots) per block 
  */
#define MAX_UINT8S_PER_BLOCK                 40

 /* The number of actual data bytes in a DSC bus frame */
#define MAX_UINT8S_PER_TIMESLOT               5

 /* The total number of bytes in a DSC bus frame */
#define DSC_BUS_FRAME_LENGTH                 6

/* The number of timeslots in a DSC bus multiframe this is 6 when the 
 * bus is operating at 512Khz. Time slot zero carries control information only. 
 */
#define DSC_BUS_NUMBER_OF_TIMESLOTS          6
#define DSC_BUS_NUMBER_OF_SPEECH_TIMESLOTS   5
   
 /* The max number of assigned timeslots on the bus is less than the absolute
  * max due to the control timeslot.
  */
#define BIC_MAX_NUMBER_OF_ASSIGNED_TIMESLOT  DSC_BUS_NUMBER_OF_SPEECH_TIMESLOTS
  
 /* Logical value used for an invalid timeslot */
#define BIC_INVALID_TIMESLOT              0x0f


#define TD_DSC_BUS_SPEED_256                 0 /* DSC Bus speed of 256  Kbit/sec */
#define TD_DSC_BUS_SPEED_512                 1 /* DSC Bus speed of 512  Kbit/sec */
#define TD_DSC_BUS_SPEED_1024                2 /* DSC Bus speed of 1024 Kbit/sec */




/******************************************************************************
 *  Valid Peripheral Audio Types
 *
 *  IMPORTANT NOTE:
 *      The even though there are many DSC Peripheral types listed below, the BIC only actually
 *      supports THREE types. They are:
 *      DSC_PERIPHERAL_COMPANDED    - one timeslot of type COMPANDED
 *      DSC_PERIPHERAL_DATA         - one timeslot of type CONTROL
 *      DSC_PERIPHERAL_LINEAR       - two timeslots, LINEAR A and LINEAR B
 *
 *      The BIC should not get timeslot allocation requests with timeslot types other that one
 *      of the three listed above.  The other types are used outside of the BIC to keep track 
 *      of other properties of the timeslot.
 ******************************************************************************/
#define DSC_PERIPHERAL_COMPANDED              0   /* Audio type for a companded speech device  */
#define DSC_PERIPHERAL_LINEAR                 1   /* Audio type for a linear speech device     */
#define DSC_PERIPHERAL_13_KBIT                2   /* Audio type for a 13 kbit speech device    */
#define DSC_PERIPHERAL_NO_AUDIO               7   /* Audio type for a none audio device        */
#define DSC_PERIPHERAL_NUMBER_OF_AUDIO_TYPES  8

    /* The following are all extensions of the audio types */ 
#define DSC_PERIPHERAL_DATA                   9   /* For transmitting data */
#define DSC_PERIPHERAL_DATA_2TS              10   /* For two timeslot data */
#define DSC_PERIPHERAL_DAI                   11   /* For DAI testing (digital audio interface) */

#define DSC_PERIPHERAL_DEFAULT              255   /* This selects the default audio type 
                                                     for the Peripheral*/





#ifdef __cplusplus       /* Allow # include in a C++ File            */
}
#endif
#endif