Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / b0f5b85a5b9d69cbfa1dd990d559a4a9c7d8f2a6 / . / mcu / interface / service / sst / usip_api_public.h
blob: 4d30c43f953e668c0ef11292eb4df1500ff4bea0 [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +0800[diff] [blame]1#ifndef __USIP_API_PUBLIC_H__
2#define __USIP_API_PUBLIC_H__
3
4#if defined(__MD97__) || defined(__MD97P__)
5#include "dsp_module_based_api_public.h"
6#else //defined(__MD97__)
7
8#include "dsp_control_public.h"
9
10/***************************************************************/
11/********* Enum for BootDoneCheck Return Value *************/
12/***************************************************************/
13typedef enum{
14 uSIP_NOTYETDONE,
15 uSIP_BOOTDONE,
16 uSIP_NOT_DEACTIVEDONE,
17 uSIP_DEACTIVEDONE
18}uSIP_BOOTDONECHECK_RETVALUE;
19
20#define uSIP_NOT_ACTIVEDONE uSIP_NOTYETDONE
21#define uSIP_ACTIVEDONE uSIP_BOOTDONE
22
23/***************************************************************/
24/********* Variable Prototype **********************************/
25/***************************************************************/
26extern kal_uint32 duty_rat[DSP_CONTROL_CDIF_CORE_NUM];
27
28/***************************************************************/
29/********* Function Prototype **********************************/
30/***************************************************************/
31/* FirstBoot API */
32extern kal_uint32 firstboot_topsm_query(DSP_CDIF_CORE_ENUM);
33
34/***** Common API *****/
35extern DSP_CONTROL_IDLE_FLAG_STATUS usip_check_idle_flag(DSP_CDIF_CORE_ENUM, kal_uint32);
36extern void query_usip_pc(kal_uint32*, kal_uint32*);
37extern void query_scq16_waite_signal(kal_uint8*, kal_uint8*);
38extern void firstboot_activate(DSP_CDIF_CORE_ENUM, kal_uint32);
39extern kal_bool is_myself_duty_rat(DSP_CDIF_CORE_ENUM, kal_uint32);
40extern kal_uint32 return_dutyrat_of_thread(DSP_CDIF_CORE_ENUM);
41
42/***** Activate Relatives *****/
43extern void usip_activate(DSP_CDIF_CORE_ENUM, kal_uint32);
44
45/***** Deactivate Relatives *****/
46extern void usip_deactivate(DSP_CDIF_CORE_ENUM, kal_uint32);
47extern USIP_CONTROL_STATUS usip_deactive_done_check(DSP_CDIF_CORE_ENUM, kal_uint32);
48
49/* Check Boot Done API*/
50extern USIP_CONTROL_STATUS usip_active_done_check(DSP_CDIF_CORE_ENUM, kal_uint32);
51extern kal_bool is_usip_vic_enable(DSP_CDIF_CORE_ENUM);
52extern void rake_later_trigger_ungate();
53/* Check status APIs */
54extern kal_bool dsp_uSIP_thread_is_deactive(DSP_CDIF_CORE_ENUM);
55
56/* DDL Relatives */
57extern void uSIP_inner_ddl_start(uSIP_API_USER_INNER ,DDL_MODE);
58extern void uSIP_brp_ddl_start(uSIP_API_USER_BRP , DDL_MODE);
59extern void uSIP_fec_tx_ddl_start(uSIP_API_USER_FEC , DDL_MODE);
60extern void uSIP_fec_rx_ddl_start(uSIP_API_USER_FEC , DDL_MODE);
61extern void uSIP_inner_ddl_status_mode_query(DDL_STATUS* , DDL_MODE*);
62extern void uSIP_brp_ddl_status_mode_query(DDL_STATUS* , DDL_MODE*);
63extern void uSIP_fec_tx_ddl_status_mode_query(DDL_STATUS* , DDL_MODE*);
64extern void uSIP_fec_rx_ddl_status_mode_query(DDL_STATUS* , DDL_MODE*);
65extern void uSIP_rake_as_tcm_for_inner_ddl_status_mode_query(DDL_STATUS *status, DDL_MODE *bin_mode);
66extern void ddl_clear_inner_ddl_protection_trigger();
67extern kal_uint32 dsp_check_ddl_user_status(DSP_CDIF_CORE_ENUM, kal_uint32);
68extern kal_bool ddl_has_user_call_activate(DSP_CDIF_CORE_ENUM, kal_uint32);
69
70/***** Sleep Flow APIs for user *****/
71/* FirstBoot API */
72#define topsm_return_dutyrat_of_inner firstboot_topsm_query(DSP_CONTROL_USIP0_INNER)
73#define topsm_return_dutyrat_of_brp firstboot_topsm_query(DSP_CONTROL_USIP0_BRP)
74#define topsm_return_dutyrat_of_fec firstboot_topsm_query(DSP_CONTROL_USIP1_FEC)
75#define topsm_return_dutyrat_of_speech firstboot_topsm_query(DSP_CONTROL_USIP1_SPEECH)
76
77#define is_myself_duty_user_of_inner(user_id) is_myself_duty_rat(DSP_CONTROL_USIP0_INNER, user_id)
78#define is_myself_duty_user_of_brp(user_id) is_myself_duty_rat(DSP_CONTROL_USIP0_BRP, user_id)
79#define is_myself_duty_user_of_fec(user_id) is_myself_duty_rat(DSP_CONTROL_USIP1_FEC, user_id)
80#define is_myself_duty_user_of_speech(user_id) is_myself_duty_rat(DSP_CONTROL_USIP1_SPEECH, user_id)
81
82/* Check idle APIs */
83#define dsp_uSIP_inner_check_idle_flag(user_id) usip_check_idle_flag(DSP_CONTROL_USIP0_INNER, user_id)
84#define dsp_uSIP_brp_check_idle_flag(user_id) usip_check_idle_flag(DSP_CONTROL_USIP0_BRP, user_id)
85#define dsp_uSIP_fec_check_idle_flag(user_id) usip_check_idle_flag(DSP_CONTROL_USIP1_FEC, user_id)
86#define dsp_uSIP_speech_check_idle_flag(user_id) usip_check_idle_flag(DSP_CONTROL_USIP1_SPEECH, user_id)
87
88/* First Boot Activate Use */
89#define inner_firstboot_activate(user_id) firstboot_activate(DSP_CONTROL_USIP0_INNER, user_id)
90#define brp_firstboot_activate(user_id) firstboot_activate(DSP_CONTROL_USIP0_BRP, user_id)
91#define fec_firstboot_activate(user_id) firstboot_activate(DSP_CONTROL_USIP1_FEC, user_id)
92#define speech_firstboot_activate(user_id) firstboot_activate(DSP_CONTROL_USIP1_SPEECH, user_id)
93
94/* Activate APIs*/
95#define dsp_uSIP_inner_activate(user_id) usip_activate(DSP_CONTROL_USIP0_INNER, user_id)
96#define dsp_uSIP_brp_activate(user_id) usip_activate(DSP_CONTROL_USIP0_BRP, user_id)
97#define dsp_uSIP_fec_activate(user_id) usip_activate(DSP_CONTROL_USIP1_FEC, user_id)
98#define dsp_uSIP_speech_activate(user_id) usip_activate(DSP_CONTROL_USIP1_SPEECH, user_id)
99
100/* Activate check APIs */
101#define uSIP_INNER_BootDoneCheck(user_id) usip_active_done_check(DSP_CONTROL_USIP0_INNER, user_id)
102#define uSIP_BRP_BootDoneCheck(user_id) usip_active_done_check(DSP_CONTROL_USIP0_BRP, user_id)
103#define uSIP_FEC_BootDoneCheck(user_id) usip_active_done_check(DSP_CONTROL_USIP1_FEC, user_id)
104#define uSIP_SPEECH_BootDoneCheck(user_id) usip_active_done_check(DSP_CONTROL_USIP1_SPEECH, user_id)
105
106#define dsp_uSIP_inner_active_done_check(user_id) uSIP_INNER_BootDoneCheck(user_id)
107#define dsp_uSIP_brp_active_done_check(user_id) uSIP_BRP_BootDoneCheck(user_id)
108#define dsp_uSIP_fec_active_done_check(user_id) uSIP_FEC_BootDoneCheck(user_id)
109#define dsp_uSIP_speech_active_done_check(user_id) uSIP_SPEECH_BootDoneCheck(user_id)
110
111
112/* Deactivate APIs */
113#define dsp_uSIP_inner_deactivate(user_id) usip_deactivate(DSP_CONTROL_USIP0_INNER, user_id)
114#define dsp_uSIP_brp_deactivate(user_id) usip_deactivate(DSP_CONTROL_USIP0_BRP, user_id)
115#define dsp_uSIP_fec_deactivate(user_id) usip_deactivate(DSP_CONTROL_USIP1_FEC, user_id)
116#define dsp_uSIP_speech_deactivate(user_id) usip_deactivate(DSP_CONTROL_USIP1_SPEECH, user_id)
117
118/* Deactivate check APIs */
119#define dsp_uSIP_inner_deactive_done_check(user_id) usip_deactive_done_check(DSP_CONTROL_USIP0_INNER, user_id)
120#define dsp_uSIP_brp_deactive_done_check(user_id) usip_deactive_done_check(DSP_CONTROL_USIP0_BRP, user_id)
121#define dsp_uSIP_fec_deactive_done_check(user_id) usip_deactive_done_check(DSP_CONTROL_USIP1_FEC, user_id)
122#define dsp_uSIP_speech_deactive_done_check(user_id) usip_deactive_done_check(DSP_CONTROL_USIP1_SPEECH, user_id)
123
124/* Check status APIs */
125#define dsp_uSIP_inner_is_deactive dsp_uSIP_thread_is_deactive(DSP_CONTROL_USIP0_INNER)
126
127/***** DDL Flow APIs for user *****/
128// Trigger DDL
129#define dsp_uSIP_inner_ddl_start(user_id, bin_mode) uSIP_inner_ddl_start(user_id, bin_mode)
130#define dsp_uSIP_brp_ddl_start(user_id,bin_mode) uSIP_brp_ddl_start(user_id, bin_mode)
131#define dsp_uSIP_fec_tx_ddl_start(user_id,bin_mode) uSIP_fec_tx_ddl_start(user_id, bin_mode)
132#define dsp_uSIP_fec_rx_ddl_start(user_id,bin_mode) uSIP_fec_rx_ddl_start(user_id, bin_mode)
133
134// Check uSIP inner DDL mode/status
135#define dsp_uSIP_inner_ddl_status_mode_query(status, bin_mode) uSIP_inner_ddl_status_mode_query(status, bin_mode)
136#define dsp_uSIP_brp_ddl_status_mode_query(status, bin_mode) uSIP_brp_ddl_status_mode_query(status, bin_mode)
137#define dsp_uSIP_fec_tx_ddl_status_mode_query(status, bin_mode) uSIP_fec_tx_ddl_status_mode_query(status, bin_mode)
138#define dsp_uSIP_fec_rx_ddl_status_mode_query(status, bin_mode) uSIP_fec_rx_ddl_status_mode_query(status, bin_mode)
139#define usip_check_ddl_user_status(thread, user_bitmap) dsp_check_ddl_user_status(thread, user_bitmap)
140
141// clear inner ddl_protection
142#define dsp_uSIP_inner_clear_ddl_protection() ddl_clear_inner_ddl_protection_trigger()
143
144#endif //defined(__MD97__)
145#endif /* __USIP_API_PUBLIC_H__ */