| 1 | /*************************************************************************** |
|---|
| 2 | * Copyright (c) 2004-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: bastmlib_clock_coupling_task.h $ |
|---|
| 11 | * $brcm_Revision: Hydra_Software_Devel/2 $ |
|---|
| 12 | * $brcm_Date: 11/2/10 4:54p $ |
|---|
| 13 | * |
|---|
| 14 | * Revision History: |
|---|
| 15 | * |
|---|
| 16 | * $brcm_Log: /magnum/syslib/astmlib/noarch/bastmlib_clock_coupling_task.h $ |
|---|
| 17 | * |
|---|
| 18 | * Hydra_Software_Devel/2 11/2/10 4:54p bandrews |
|---|
| 19 | * SW3548-1159: updated clock coupling recovery to use a second timeout |
|---|
| 20 | * value |
|---|
| 21 | * |
|---|
| 22 | * Hydra_Software_Devel/1 7/17/09 6:56p bandrews |
|---|
| 23 | * PR49215: playback support |
|---|
| 24 | ***************************************************************************/ |
|---|
| 25 | |
|---|
| 26 | #include "bstd.h" |
|---|
| 27 | #include "bastmlib.h" |
|---|
| 28 | #include "bastmlib_clock_reference.h" |
|---|
| 29 | #include "bsyslib.h" |
|---|
| 30 | |
|---|
| 31 | #ifndef BASTMLIB_CLOCK_COUPLING_TASK_H__ |
|---|
| 32 | #define BASTMLIB_CLOCK_COUPLING_TASK_H__ |
|---|
| 33 | |
|---|
| 34 | #define BASTMLIB_CLOCK_COUPLING_DEFAULT_INITIAL_ACQUISITION_TIME 300 |
|---|
| 35 | #define BASTMLIB_CLOCK_COUPLING_DEFAULT_PROCESSING_FREQUENCY 2000 |
|---|
| 36 | #define BASTMLIB_CLOCK_COUPLING_DEFAULT_IDEAL_PROCESSING_FREQUENCY 10000 |
|---|
| 37 | #define BASTMLIB_CLOCK_COUPLING_DEFAULT_SETTLING_TIME 500 |
|---|
| 38 | |
|---|
| 39 | typedef enum |
|---|
| 40 | { |
|---|
| 41 | BASTMlib_ClockCoupling_StateMachineSignal_eReset, |
|---|
| 42 | BASTMlib_ClockCoupling_StateMachineSignal_eClockReferencePass, |
|---|
| 43 | BASTMlib_ClockCoupling_StateMachineSignal_eClockReferenceFailure, |
|---|
| 44 | BASTMlib_ClockCoupling_StateMachineSignal_eMax |
|---|
| 45 | } BASTMlib_ClockCoupling_StateMachineSignal; |
|---|
| 46 | |
|---|
| 47 | typedef struct |
|---|
| 48 | { |
|---|
| 49 | bool bAcquire; |
|---|
| 50 | BSYSlib_Timer_Handle hTimer; |
|---|
| 51 | BASTMlib_ClockReference_Handle hReference; |
|---|
| 52 | } BASTMlib_ClockCouplingTaskState; |
|---|
| 53 | |
|---|
| 54 | void BASTMlib_P_ClockCoupling_GetDefaultConfig( |
|---|
| 55 | BASTMlib_Config * psConfig |
|---|
| 56 | ); |
|---|
| 57 | |
|---|
| 58 | BERR_Code BASTMlib_P_ClockCoupling_TimerExpired( |
|---|
| 59 | void * pvParm1, /* first user context parameter [in] */ |
|---|
| 60 | int iParm2, /* second user context parameter [in] */ |
|---|
| 61 | BSYSlib_Timer_Handle hTimer /* the handle of the timer that expired [in] */ |
|---|
| 62 | ); |
|---|
| 63 | |
|---|
| 64 | BERR_Code BASTMlib_P_ClockCoupling_Process( |
|---|
| 65 | BASTMlib_Handle hAstm |
|---|
| 66 | ); |
|---|
| 67 | |
|---|
| 68 | void BASTMlib_P_ClockCoupling_StateMachine_SendSignal( |
|---|
| 69 | BASTMlib_Handle hAstm, |
|---|
| 70 | BASTMlib_ClockCoupling_StateMachineSignal eSignal |
|---|
| 71 | ); |
|---|
| 72 | |
|---|
| 73 | BERR_Code BASTMlib_P_ClockCoupling_StateChangeHandler( |
|---|
| 74 | BASTMlib_Handle hAstm |
|---|
| 75 | ); |
|---|
| 76 | |
|---|
| 77 | void BASTMlib_P_ClockCoupling_GetMaxAcquisitionTime( |
|---|
| 78 | BASTMlib_Handle hAstm, |
|---|
| 79 | unsigned int * puiMaxAcquisitionTime |
|---|
| 80 | ); |
|---|
| 81 | |
|---|
| 82 | #endif /* BASTMLIB_CLOCK_COUPLING_TASK_H__ */ |
|---|
| 83 | |
|---|
