1 /*******************************************************************
2 Components for embedded applications builded for
3 laboratory and medical instruments firmware
5 cmd_stm.c - interconnection of Stepper Motor control
6 subsystem with RS-232 command processor
7 used mainly for controller tuning
9 Copyright (C) 2001 by Pavel Pisa pisa@cmp.felk.cvut.cz
10 (C) 2002 by PiKRON Ltd. http://www.pikron.com
12 *******************************************************************/
24 * cmd_opchar_getreg - selects the right axis
26 * pxmc is designed for multi axis motion control, so each axis must be identificated.
27 * This done by a capital letter. The first axis must be A, the 2nd B, etc.
29 pxmc_state_t *cmd_opchar_getreg(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
34 if(chan>=pxmc_main_list.pxml_cnt) return NULL;
35 mcs=pxmc_main_list.pxml_arr[chan];
41 * cmd_do_reg_go - checks the command format validity and calls pxmc_go.
43 * if pxmc_go returns -1, cmd_do_reg_go returns -1.
45 int cmd_do_reg_go(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
49 if(*param[2]!=':') return -CMDERR_OPCHAR;
50 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
51 val=atol(param[3])<<PXMC_SUBDIV(mcs);
52 val=pxmc_go(mcs,val,0,0);
60 * cmd_do_pwm - checks the command format validity and calls pxmc_set_const_out.
63 int cmd_do_pwm(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
67 if(*param[2]!=':') return -CMDERR_OPCHAR;
68 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
70 pxmc_set_const_out(mcs,val);
75 * cmd_do_reg_hh - checks the command format validity and calls pxmc_hh (home hardware).
77 * if pxmc_hh returns -1, cmd_do_reg_hh returns -1.
79 int cmd_do_reg_hh(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
83 if(*param[2]!=':') return -CMDERR_OPCHAR;
84 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
93 * cmd_do_reg_spd - checks the command format validity and calls pxmc_spd.
95 * if pxmc_spd returns -1, cmd_do_reg_spd returns -1.
97 int cmd_do_reg_spd(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
101 if(*param[2]!=':') return -CMDERR_OPCHAR;
102 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
104 val=pxmc_spd(mcs,val,0);
111 * cmd_do_reg_spdfg - checks the command format validity and calls pxmc_spdfg.
113 * if pxmc_spdfg returns -1, cmd_do_reg_spdfg returns -1.
115 int cmd_do_reg_spdfg(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
119 if(*param[2]!=':') return -CMDERR_OPCHAR;
120 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
122 val=pxmc_spdfg(mcs,val,0);
129 * cmd_do_stop - checks the command format validity and calls pxmc_stop.
132 int cmd_do_stop(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
135 if(*param[2]!=':') return -CMDERR_OPCHAR;
136 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
142 * cmd_do_release - checks the command format validity and calls pxmc_set_const_out(mcs,0).
145 int cmd_do_release(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
148 if(*param[2]!=':') return -CMDERR_OPCHAR;
149 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
150 pxmc_set_const_out(mcs,0);
155 * cmd_do_clrerr - checks the command format validity, clears the error flag.
157 * it also stop the rotation calling pxmc_set_const_out(mcs,0)
159 int cmd_do_clrerr(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
162 if(*param[2]!=':') return -CMDERR_OPCHAR;
163 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
164 pxmc_set_const_out(mcs,0);
165 pxmc_clear_flag(mcs,PXMS_ERR_b);
170 * cmd_do_zero - checks the command format validity, sets axis position to 0.
172 * it also stop the rotation calling pxmc_set_const_out(mcs,0)
174 int cmd_do_zero(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
177 if(*param[2]!=':') return -CMDERR_OPCHAR;
178 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
179 pxmc_set_const_out(mcs,0);
180 pxmc_axis_set_pos(mcs,0);
185 * cmd_do_align - checks the command format validity, sets offset between table and IRC counter to 0 .
187 * it also stop the rotation calling pxmc_set_const_out(mcs,0) and sets axis position to 0.
189 int cmd_do_align(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
192 if(*param[2]!=':') return -CMDERR_OPCHAR;
193 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
194 pxmc_set_const_out(mcs,0);
195 pxmc_axis_set_pos(mcs,0);
201 * cmd_do_reg_rw_pos - read or write function, param is converted in 'long' and shifted
203 * if the command typed is a write function, records the value,
204 * if it is a read function returns the value asked.
207 int cmd_do_reg_rw_pos(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
214 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
215 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
216 ptr=(long*)((long)des->info[0]+(char*)mcs);
219 *ptr=val<<PXMC_SUBDIV(mcs);
221 return cmd_opchar_replong(cmd_io, param, (*ptr)>>PXMC_SUBDIV(mcs), 0, 0);
227 * cmd_do_reg_short_val - read or write function, param is converted in 'integer'
229 * if the command typed is a write function, records the value,
230 * if it is a read function returns the value asked.
233 int cmd_do_reg_short_val(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
240 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
241 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
242 ptr=(short*)((long)des->info[0]+(char*)mcs);
247 return cmd_opchar_replong(cmd_io, param, (long)*ptr, 0, 0);
253 * cmd_do_reg_long_val - read or write function, param is converted in 'long'
255 * if the command typed is a write function, records the value,
256 * if it is a read function returns the value asked.
258 int cmd_do_reg_long_val(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
265 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
266 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
267 ptr=(long*)((long)des->info[0]+(char*)mcs);
272 return cmd_opchar_replong(cmd_io, param, (long)*ptr, 0, 0);
279 * cmd_do_axis_mode - checks the command format and busy flag validity, calls pxmc_axis_mode
281 * if pxmc_axis_mode returns -1, cmd_do_axis_mode returns -1.
283 int cmd_do_axis_mode(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
287 if(*param[2]!=':') return -CMDERR_OPCHAR;
288 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
289 if(mcs->pxms_flg&PXMS_BSY_m) return -CMDERR_BSYREG;
291 val=pxmc_axis_mode(mcs,val);
298 int cmd_do_regptmod_short_val(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
305 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
306 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
307 ptr=(short*)((long)des->info[0]+(char*)mcs);
309 if(mcs->pxms_flg&PXMS_BSY_m) return -CMDERR_BSYREG;
310 pxmc_set_const_out(mcs,0);
312 if((val<((long)des->info[1])) || (val>((long)des->info[2])))
313 return -CMDERR_BADPAR;
315 val=pxmc_axis_mode(mcs,0);
319 return cmd_opchar_replong(cmd_io, param, (long)*ptr, 0, 0);
326 * cmd_do_reg_type - no code written, will set controller structure
328 int cmd_do_reg_type(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
330 /* should set controller structure */
336 * cmd_do_regsfrq - sets or returns smapling frequency
339 int cmd_do_regsfrq(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
344 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
347 return pxmc_sfi_sel(val);
349 return cmd_opchar_replong(cmd_io, param, pxmc_get_sfi_hz(NULL), 0, 0);
353 #endif /* WITH_SFI_SEL */
356 /* debugging functions */
357 int cmd_do_reg_dbgset(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
363 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
364 if((mcs=cmd_opchar_getreg(cmd_io,des,param))==NULL) return -CMDERR_BADREG;
367 pxmc_dbgset(mcs,pxmc_dbg_ene_as,val);
369 cmd_io_write(cmd_io,param[0],param[2]-param[0]);
370 cmd_io_putc(cmd_io,'=');
371 cmd_io_putc(cmd_io,mcs->pxms_flg&PXMS_DBG_m?'1':'0');
377 int cmd_do_reg_dbgpre(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
379 pxmc_dbg_hist_t *hist;
385 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
387 if(si_long(&ps,&count,0)<0) return -CMDERR_BADPAR;
388 if(!count||(count>0x10000)) return -CMDERR_BADPAR;
389 pxmc_dbg_histfree(NULL);
390 if((hist=pxmc_dbg_histalloc(count+2))==NULL) return -CMDERR_NOMEM;
391 for(i=0;i<count;i++){
392 /* ps=cmd_rs232_rdline(cmd_io,1); */ /* !!!!!!!!! */
393 if(si_long(&ps,&val,0)<0) return -CMDERR_BADPAR;
401 int cmd_do_reg_dbghis(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
403 pxmc_dbg_hist_t *hist;
408 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
410 if(si_long(&ps,&count,0)<0) return -CMDERR_BADPAR;
411 if(!count||(count>0x10000)) return -CMDERR_BADPAR;
413 for(i=0;i<count;i++){
414 if(hist&&(&hist->buff[i]<hist->end))
418 /* printf("%ld\r\n",val); */ /* !!!!!!!! */
424 int cmd_do_reg_dbggnr(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
430 if((opchar=cmd_opchar_check(cmd_io,des,param))<0) return opchar;
431 for(i=0;i<pxmc_main_list.pxml_cnt;i++){
432 mcs=pxmc_main_list.pxml_arr[i];
433 if(mcs&&(mcs->pxms_flg&PXMS_DBG_m)){
434 if(pxmc_dbg_gnr(mcs)<0){
435 for(i=0;i<pxmc_main_list.pxml_cnt;i++){
436 mcs=pxmc_main_list.pxml_arr[i];
437 if(mcs&&(mcs->pxms_flg&PXMS_DBG_m))
438 pxmc_stop(pxmc_main_list.pxml_arr[i],0);
440 return -CMDERR_BADREG;
444 pxmc_dbg_hist->ptr=pxmc_dbg_hist->buff;
449 /* motor executable commands */
450 cmd_des_t const cmd_des_go={0, CDESM_OPCHR|CDESM_RW,
451 "G?","go to target position",cmd_do_reg_go,{}};
452 cmd_des_t const cmd_des_pwm={0, CDESM_OPCHR|CDESM_RW,
453 "PWM?","direct axis PWM output",cmd_do_pwm,{}};
454 cmd_des_t const cmd_des_hh={0, CDESM_OPCHR,"HH?","hard home request for axis",cmd_do_reg_hh,{}};
455 cmd_des_t const cmd_des_spd={0, CDESM_OPCHR,"SPD?","speed request for axis",cmd_do_reg_spd,{}};
456 cmd_des_t const cmd_des_spdfg={0, CDESM_OPCHR,"SPDFG?",
457 "fine grained speed request for axis",cmd_do_reg_spdfg,{}};
458 cmd_des_t const cmd_des_stop={0, CDESM_OPCHR,
459 "STOP?","stop motion of requested axis",cmd_do_stop,{}};
460 cmd_des_t const cmd_des_release={0, CDESM_OPCHR,
461 "RELEASE?","releases axis closed loop control",cmd_do_release,{}};
462 cmd_des_t const cmd_des_zero={0, CDESM_OPCHR,
463 "ZERO?","zero actual position",cmd_do_zero,{}};
464 cmd_des_t const cmd_des_align={0, CDESM_OPCHR,
465 "ALIGN?","align commutator",cmd_do_align,{}};
466 cmd_des_t const cmd_des_clrerr={0, CDESM_OPCHR,
467 "PURGE?"," clear 'axis in error state' flag",cmd_do_clrerr,{}};
468 /* motors and controllers variables */
469 cmd_des_t const cmd_des_ap={0, CDESM_OPCHR|CDESM_RD,
470 "AP?","actual position",cmd_do_reg_rw_pos,
471 {(char*)pxmc_state_offs(pxms_ap),
473 cmd_des_t const cmd_des_st={0, CDESM_OPCHR|CDESM_RD,
474 "ST?","axis status bits encoded in number",cmd_do_reg_short_val,
475 {(char*)pxmc_state_offs(pxms_flg),
477 cmd_des_t const cmd_des_axerr={0, CDESM_OPCHR|CDESM_RD,
478 "AXERR?","last axis error code",cmd_do_reg_short_val,
479 {(char*)pxmc_state_offs(pxms_errno),
482 cmd_des_t const cmd_des_r_one={0, CDESM_OPCHR,
483 "R?","send R?! or FAIL?! at axis finish",cmd_do_r_one,{}};
485 cmd_des_t const cmd_des_regp={0, CDESM_OPCHR|CDESM_RW,
486 "REGP?","controller proportional gain",cmd_do_reg_short_val,
487 {(char*)pxmc_state_offs(pxms_p),
489 cmd_des_t const cmd_des_regi={0, CDESM_OPCHR|CDESM_RW,
490 "REGI?","controller integral gain",cmd_do_reg_short_val,
491 {(char*)pxmc_state_offs(pxms_i),
493 cmd_des_t const cmd_des_regd={0, CDESM_OPCHR|CDESM_RW,
494 "REGD?","controller derivative gain",cmd_do_reg_short_val,
495 {(char*)pxmc_state_offs(pxms_d),
497 cmd_des_t const cmd_des_regs1={0, CDESM_OPCHR|CDESM_RW,
498 "REGS1?","controller S1",cmd_do_reg_short_val,
499 {(char*)pxmc_state_offs(pxms_s1),
501 cmd_des_t const cmd_des_regs2={0, CDESM_OPCHR|CDESM_RW,
502 "REGS2?","controller S2",cmd_do_reg_short_val,
503 {(char*)pxmc_state_offs(pxms_s2),
505 cmd_des_t const cmd_des_regmd={0, CDESM_OPCHR|CDESM_RW,
506 "REGMD?","maximal allowed position error",cmd_do_reg_rw_pos,
507 {(char*)pxmc_state_offs(pxms_md),
509 cmd_des_t const cmd_des_regms={0, CDESM_OPCHR|CDESM_RW,
510 "REGMS?","maximal speed",cmd_do_reg_long_val,
511 {(char*)pxmc_state_offs(pxms_ms),
513 cmd_des_t const cmd_des_regacc={0, CDESM_OPCHR|CDESM_RW,
514 "REGACC?","maximal acceleration",cmd_do_reg_long_val,
515 {(char*)pxmc_state_offs(pxms_ma),
517 cmd_des_t const cmd_des_regme={0, CDESM_OPCHR|CDESM_RW,
518 "REGME?","maximal PWM energy or voltage for axis",cmd_do_reg_short_val,
519 {(char*)pxmc_state_offs(pxms_me),
521 cmd_des_t const cmd_des_regcfg={0, CDESM_OPCHR|CDESM_RW,
522 "REGCFG?","hard home and profile configuration",cmd_do_reg_short_val,
523 {(char*)pxmc_state_offs(pxms_cfg),
525 cmd_des_t const cmd_des_ptirc={0, CDESM_OPCHR|CDESM_RW,
526 "REGPTIRC?","number of irc pulses per phase table",cmd_do_regptmod_short_val,
527 {(char*)pxmc_state_offs(pxms_ptirc),
528 (char*)4,(char*)10000}};
529 cmd_des_t const cmd_des_ptper={0, CDESM_OPCHR|CDESM_RW,
530 "REGPTPER?","number of elmag. revolutions per phase table",cmd_do_regptmod_short_val,
531 {(char*)pxmc_state_offs(pxms_ptper),
532 (char*)1,(char*)100}};
533 cmd_des_t const cmd_des_ptshift={0, CDESM_OPCHR|CDESM_RW,
534 "REGPTSHIFT?","shift (in irc) of generated phase curves",cmd_do_reg_short_val,
535 {(char*)pxmc_state_offs(pxms_ptshift),
537 cmd_des_t const cmd_des_ptvang={0, CDESM_OPCHR|CDESM_RW,
538 "REGPTVANG?","angle (in irc) between rotor and stator mag. fld.",cmd_do_reg_short_val,
539 {(char*)pxmc_state_offs(pxms_ptvang),
541 cmd_des_t const cmd_des_pwm1cor={0, CDESM_OPCHR|CDESM_RW,
542 "REGPWM1COR?","PWM1 correction",cmd_do_reg_short_val,
543 {(char*)pxmc_state_offs(pxms_pwm1cor),
545 cmd_des_t const cmd_des_pwm2cor={0, CDESM_OPCHR|CDESM_RW,
546 "REGPWM2COR?","PWM2 correction",cmd_do_reg_short_val,
547 {(char*)pxmc_state_offs(pxms_pwm2cor),
549 cmd_des_t const cmd_des_axis_mode={0, CDESM_OPCHR|CDESM_WR,
550 "REGMODE?","axis working mode",cmd_do_axis_mode,
553 cmd_des_t const cmd_des_regsfrq={0, CDESM_OPCHR|CDESM_RW,
554 "REGSFRQ","set new sampling frequency",cmd_do_regsfrq,{}};
555 #endif /* WITH_SFI_SEL */
556 /* axes debugging and tuning */
557 cmd_des_t const cmd_des_reg_type={0, CDESM_OPCHR|CDESM_RW,
558 "REGTYPE?","unused",cmd_do_reg_type,{}};
559 cmd_des_t const cmd_des_reg_dbgset={0, CDESM_OPCHR|CDESM_RW,
560 "REGDBG?","sets debug flag",cmd_do_reg_dbgset,{}};
561 cmd_des_t const cmd_des_reg_dbgpre={0, CDESM_OPCHR|CDESM_WR,
562 "REGDBGPRE","store reference course",cmd_do_reg_dbgpre,{}};
563 cmd_des_t const cmd_des_reg_dbghis={0, CDESM_OPCHR|CDESM_WR,
564 "REGDBGHIS","read history course",cmd_do_reg_dbghis,{}};
565 cmd_des_t const cmd_des_reg_dbggnr={0, CDESM_OPCHR|CDESM_WR,
566 "REGDBGGNR","controller response to HIST course",cmd_do_reg_dbggnr,{}};
568 cmd_des_t const *cmd_stm_default[]={
603 #endif /* WITH_SFI_SEL */