1 /******************************************************************************
2 *
3 * Copyright(c) 2019 - 2020 Realtek Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * Author: vincent_fann@realtek.com
15 *
16 *****************************************************************************/
17 #include "phl_headers.h"
18
19 #ifdef CONFIG_FSM
20
21 #define MIN(X, Y) (((X) < (Y)) ? (X) : (Y))
22
23 /**
24 * Deal with original command thread comd
25 */
26 char unknow_func[8] = "no_name";
27
cmd2hal(struct _cmd_obj * pcmd)28 void *cmd2hal(struct _cmd_obj *pcmd)
29 {
30 return pcmd->phl_info->hal;
31 }
32
33 /* usually called when stopping fsm */
cmd_discard_msg_job(struct _cmd_obj * pcmd,struct fsm_msg * msg)34 void cmd_discard_msg_job(struct _cmd_obj *pcmd, struct fsm_msg *msg)
35 {
36 void *d = phl_to_drvpriv(pcmd->phl_info);
37 struct phl_cmd_job *job = (struct phl_cmd_job *)msg->param;
38
39 /* inform core to free param */
40 if (job->id == JOB_RUN_FUNC &&
41 (job->u.cmd.fptr || job->u.cmd.func)) {
42 FSM_INFO(pcmd->fsm, "%s: discard %s:%s\n",
43 phl_fsm_obj_name(pcmd->fsm_obj),
44 job_name(pcmd, (u8)job->id),
45 (char *)job->u.cmd.name);
46
47 /* we have to callback to core to free job
48 * Also release wait_complition if has
49 */
50 job->u.cmd.fptr(job->u.cmd.priv, job->u.cmd.parm, true);
51 } else
52 FSM_INFO(pcmd->fsm, "%s: discard %s\n",
53 phl_fsm_obj_name(pcmd->fsm_obj),
54 job_name(pcmd, (u8)job->id));
55
56 _os_kmem_free(d, (u8 *)msg->param, msg->param_sz);
57 _os_kmem_free(d, (u8 *)msg, sizeof(*msg));
58 }
59
rtw_phl_job_fill_fptr(void * phl,struct phl_cmd_job * job,void * func,void * priv,void * parm,char * name,enum PWR_LEVEL pwr)60 enum rtw_phl_status rtw_phl_job_fill_fptr(void *phl, struct phl_cmd_job *job,
61 void *func, void *priv, void *parm, char *name, enum PWR_LEVEL pwr)
62 {
63 struct phl_info_t *phl_info = (struct phl_info_t *)phl;
64 void *d = phl_to_drvpriv(phl_info);
65
66 job->id = JOB_RUN_FUNC;
67 job->pwr_level = pwr;
68 job->u.cmd.fptr = (int (*)(void *priv, void *param, bool discard))func;
69 job->u.cmd.priv = priv;
70 job->u.cmd.parm = parm;
71 _os_mem_set(d, job->u.cmd.name, 0, RTW_PHL_JOB_NAME_LEN);
72 if (name != NULL)
73 _os_mem_cpy(d, job->u.cmd.name, name,
74 MIN((RTW_PHL_JOB_NAME_LEN - 1),
75 _os_strlen((u8 *)name)));
76 else
77 _os_mem_cpy(d, job->u.cmd.name, unknow_func,
78 MIN((RTW_PHL_JOB_NAME_LEN - 1),
79 _os_strlen((u8 *)unknow_func)));
80 return RTW_PHL_STATUS_SUCCESS;
81 }
82
83 /**
84 * @phl: phl private structure
85 * @func: function pointer to be runed
86 * @priv: 1st param of function pointer
87 * @parm: 2nd param of function pointer
88 * @name: function name for debug message (optional)
89 * @pwr: refers to enum PWR_LEVEL
90 */
91 /* TODO remove below when no reference */
rtw_phl_job_add_fptr(void * phl,void * func,void * priv,void * parm,char * name,enum PWR_LEVEL pwr)92 enum rtw_phl_status rtw_phl_job_add_fptr(void *phl, void *func,
93 void *priv, void *parm, char *name, enum PWR_LEVEL pwr)
94 {
95 struct phl_info_t *phl_info = (struct phl_info_t *)phl;
96 struct phl_cmd_job job;
97
98 _os_mem_set(phl_to_drvpriv(phl_info), &job, 0, sizeof(job));
99 rtw_phl_job_fill_fptr(phl, &job, func, priv, parm, name, pwr);
100
101 return phl_cmd_complete_job(phl, &job);
102 }
103
job_run_func_hdl(struct _cmd_obj * pcmd,void * param)104 static int job_run_func_hdl(struct _cmd_obj *pcmd, void *param)
105 {
106 struct phl_cmd_job *job = (struct phl_cmd_job *)param;
107
108 if (job->u.cmd.fptr)
109 return job->u.cmd.fptr(job->u.cmd.priv, job->u.cmd.parm, false);
110 else /* TODO remove else */
111 return job->u.cmd.func(job->u.cmd.priv, job->u.cmd.parm);
112 }
113
114 /** JOB_ADD_STA
115 * For EXTERNAL application to add sta entry (expose)
116 * @phl: phl private structure
117 * @sta: see rtw_phl_stainfo_t
118 * @sync: Async or SYNC mode
119 */
rtw_hal_add_sta_entry_job(void * phl,struct rtw_phl_stainfo_t * sta,enum JOB_SYNC sync)120 enum rtw_phl_status rtw_hal_add_sta_entry_job(void *phl,
121 struct rtw_phl_stainfo_t *sta, enum JOB_SYNC sync)
122 {
123 struct phl_info_t *phl_info = (struct phl_info_t *)phl;
124 void *d = phl_to_drvpriv(phl_info);
125 struct phl_cmd_job job;
126
127 _os_mem_set(d, &job, 0, sizeof(job));
128 job.id = JOB_ADD_STA_ENTRY;
129 job.u.sta.sta = sta;
130 job.wait.sync = sync;
131
132 return phl_cmd_complete_job(phl, &job);
133 }
134
job_add_sta_entry_hdl(struct _cmd_obj * pcmd,void * param)135 static int job_add_sta_entry_hdl(struct _cmd_obj *pcmd, void *param)
136 {
137 struct phl_cmd_job *job = (struct phl_cmd_job *)param;
138
139 return rtw_hal_add_sta_entry(cmd2hal(pcmd), job->u.sta.sta);
140 }
141
job_add_macid_hdl(struct _cmd_obj * pcmd,void * param)142 static int job_add_macid_hdl(struct _cmd_obj *pcmd, void *param)
143 {
144 FSM_INFO(pcmd->fsm, "job: %s()\n", __func__);
145 return 0;
146 }
147
148 struct job_hdl_ent job_hdl_tbl[] = {
149 {JOB_RUN_FUNC, "JOB_RUN_FUNC", job_run_func_hdl},
150 {JOB_ADD_STA_ENTRY, "JOB_ADD_STA_ENTRY", job_add_sta_entry_hdl},
151 {JOB_ADD_MACID, "JOB_ADD_MACID", job_add_macid_hdl}
152 };
153
cmd_set_job_tbl(struct _cmd_obj * pcmd)154 void cmd_set_job_tbl(struct _cmd_obj *pcmd)
155 {
156 pcmd->job_tbl = job_hdl_tbl;
157 }
158
job_name(struct _cmd_obj * pcmd,u8 id)159 char *job_name(struct _cmd_obj *pcmd, u8 id)
160 {
161 if (id >= JOB_MAX)
162 FSM_ERR(pcmd->fsm, "%s: job id %d not found\n",
163 phl_fsm_obj_name(pcmd->fsm_obj), id);
164
165 return job_hdl_tbl[id].name;
166 }
167
phl_cmd_do_job(struct _cmd_obj * pcmd,void * param)168 int phl_cmd_do_job(struct _cmd_obj *pcmd, void *param)
169 {
170 struct phl_cmd_job *job = (struct phl_cmd_job *)param;
171 void *d = phl_to_drvpriv(pcmd->phl_info);
172 int rtn = FSM_FREE_PARAM;
173
174
175 if (job->id == JOB_RUN_FUNC)
176 FSM_INFO(pcmd->fsm, "%s: %s (%s)\n",
177 phl_fsm_obj_name(pcmd->fsm_obj),
178 (char *)job_name(pcmd, (u8)job->id),
179 (char *)job->u.cmd.name);
180 else
181 FSM_INFO(pcmd->fsm, "%s: %s\n",
182 phl_fsm_obj_name(pcmd->fsm_obj),
183 (char *)job_name(pcmd, (u8)job->id));
184
185 job->wait.rtn = pcmd->job_tbl[job->id].job_func(pcmd, job);
186
187 if (job->wait.sync == JOB_WAIT_COMPLETION) {
188
189 _os_event_set(d, &(job->wait.done));
190 /* Inform fsm framwork do NOT free param
191 * SYNC mode use caller's local job variable
192 */
193 rtn = FSM_KEEP_PARAM;
194 }
195 return rtn;
196 }
197 #endif /*CONFIG_FSM*/
198
199