| 1 | /*************************************************************************** |
|---|
| 2 | * Copyright (c) 2003-2010, Broadcom Corporation |
|---|
| 3 | * All Rights Reserved |
|---|
| 4 | * Confidential Property of Broadcom Corporation |
|---|
| 5 | * |
|---|
| 6 | * THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE |
|---|
| 7 | * AGREEMENT BETWEEN THE USER AND BROADCOM. YOU HAVE NO RIGHT TO USE OR |
|---|
| 8 | * EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT. |
|---|
| 9 | * |
|---|
| 10 | * $brcm_Workfile: bxpt_spid.h $ |
|---|
| 11 | * $brcm_Revision: Hydra_Software_Devel/1 $ |
|---|
| 12 | * $brcm_Date: 10/25/10 2:09p $ |
|---|
| 13 | * |
|---|
| 14 | * Porting interface code for the secondary PID channel. |
|---|
| 15 | * |
|---|
| 16 | * Revision History: |
|---|
| 17 | * |
|---|
| 18 | * $brcm_Log: /magnum/portinginterface/xpt/base2/bxpt_spid.h $ |
|---|
| 19 | * |
|---|
| 20 | * Hydra_Software_Devel/1 10/25/10 2:09p gmullen |
|---|
| 21 | * SW7425-15: Moved srcs to base2 folder |
|---|
| 22 | * |
|---|
| 23 | * Hydra_Software_Devel/1 10/8/10 2:58p gmullen |
|---|
| 24 | * SW7425-15: Added header files |
|---|
| 25 | * |
|---|
| 26 | * Hydra_Software_Devel/1 5/13/05 1:27p gmullen |
|---|
| 27 | * PR15309: First draft of XPT PI. |
|---|
| 28 | * |
|---|
| 29 | ***************************************************************************/ |
|---|
| 30 | |
|---|
| 31 | #ifndef BXPT_SPID_H__ |
|---|
| 32 | #define BXPT_SPID_H__ |
|---|
| 33 | |
|---|
| 34 | #include "bxpt.h" |
|---|
| 35 | |
|---|
| 36 | #ifdef __cplusplus |
|---|
| 37 | extern "C"{ |
|---|
| 38 | #endif |
|---|
| 39 | |
|---|
| 40 | /*= Module Overview ********************************************************* |
|---|
| 41 | |
|---|
| 42 | Overview |
|---|
| 43 | |
|---|
| 44 | Usage / Sample Code |
|---|
| 45 | |
|---|
| 46 | %CODE{"cpp"}% |
|---|
| 47 | %ENDCODE% |
|---|
| 48 | ***************************************************************************/ |
|---|
| 49 | |
|---|
| 50 | /*************************************************************************** |
|---|
| 51 | Summary: |
|---|
| 52 | Settings done on a per-SPID channel basis. Each secondary PID channel can |
|---|
| 53 | perform one of these actions on its PIDs. The reserved values should not |
|---|
| 54 | be used. |
|---|
| 55 | ****************************************************************************/ |
|---|
| 56 | typedef enum BXPT_Spid_eChannelMode |
|---|
| 57 | { |
|---|
| 58 | BXPT_Spid_eChannelMode_Disable = 0, /* Disable this secondary PID table entry */ |
|---|
| 59 | BXPT_Spid_eChannelMode_Reserved1 = 1, /* Reserved. Do not use. */ |
|---|
| 60 | BXPT_Spid_eChannelMode_Reserved2 = 2, /* Reserved. Do not use. */ |
|---|
| 61 | BXPT_Spid_eChannelMode_Reserved3 = 3, /* Reserved. Do not use. */ |
|---|
| 62 | BXPT_Spid_eChannelMode_Reserved4 = 4, /* Reserved. Do not use. */ |
|---|
| 63 | BXPT_Spid_eChannelMode_Reserved5 = 5, /* Reserved. Do not use. */ |
|---|
| 64 | BXPT_Spid_eChannelMode_Merge = 6, /* Merge PIDs from primary and secondary on this channel */ |
|---|
| 65 | BXPT_Spid_eChannelMode_Remap = 7 /* Remap PIDs from secondary to primary on this channel. */ |
|---|
| 66 | } |
|---|
| 67 | BXPT_Spid_eChannelMode; |
|---|
| 68 | |
|---|
| 69 | /*************************************************************************** |
|---|
| 70 | Summary: |
|---|
| 71 | Set the configuration for the given secondary PID channel. |
|---|
| 72 | |
|---|
| 73 | Description: |
|---|
| 74 | Set the secondary PID and the SPID mode for the given channel. |
|---|
| 75 | |
|---|
| 76 | Returns: |
|---|
| 77 | BERR_SUCCESS - Configuration set. |
|---|
| 78 | BERR_INVALID_PARAMETER - Bad input parameter |
|---|
| 79 | |
|---|
| 80 | See Also: |
|---|
| 81 | ****************************************************************************/ |
|---|
| 82 | BERR_Code BXPT_Spid_ConfigureChannel( |
|---|
| 83 | BXPT_Handle hXpt, /* [in] Handle for this transport */ |
|---|
| 84 | unsigned int ChannelNum, /* [in] Which secondary channel to configure. */ |
|---|
| 85 | unsigned int Spid, /* [in] Secondary PID to use. */ |
|---|
| 86 | BXPT_Spid_eChannelMode Mode /* [in] Mode for secondary PIDs on this channel. */ |
|---|
| 87 | ); |
|---|
| 88 | |
|---|
| 89 | #ifdef __cplusplus |
|---|
| 90 | } |
|---|
| 91 | #endif |
|---|
| 92 | |
|---|
| 93 | #endif |
|---|
| 94 | |
|---|
