PMSM_Controller_interface.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="rtwreport.css" /><script language="JavaScript" type="text/javascript">function rtwTableShrink(o) {var t = o.nextSibling;if (t.nodeType != 1) {t = t.nextSibling;}if (t.style.display == "none") {t.style.display = "";o.innerHTML = "[-]"} else {t.style.display = "none";o.innerHTML = "[+] ... "}}</script><script language="JavaScript" type="text/javascript" src="rtwreport_utils.js"></script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>
  4. Code Interface Report for PMSM_Controller
  5. </title>
  6. </head>
  7. <body ONLOAD="try {if (top) {if (top.rtwPageOnLoad) top.rtwPageOnLoad('rtwIdCodeInterface'); else local_onload();}} catch(err) {};">
  8. <h1>
  9. Code Interface Report for PMSM_Controller
  10. </h1>
  11. <h3>
  12. Table of Contents
  13. </h3>
  14. <ul>
  15. <li>
  16. <a href="#sec_Entry-Point_Functions">
  17. Entry-Point Functions
  18. </a>
  19. </li>
  20. <li>
  21. <a href="#sec_Inports">
  22. Inports
  23. </a>
  24. </li>
  25. <li>
  26. <a href="#sec_Outports">
  27. Outports
  28. </a>
  29. </li>
  30. <li>
  31. <a href="#sec_Interface_Parameters">
  32. Interface Parameters
  33. </a>
  34. </li>
  35. <li>
  36. <a href="#sec_Data_Stores">
  37. Data Stores
  38. </a>
  39. </li>
  40. </ul>
  41. <h3>
  42. <a name="sec_Entry-Point_Functions">
  43. Entry-Point Functions
  44. </a>
  45. </h3>
  46. <p>
  47. Function: <a href="PMSM_Controller_c.html#fcn_PMSM_Controller_initialize">PMSM_Controller_initialize</a>
  48. </p>
  49. <table width="100%" class="AltRow" cellspacing="0">
  50. <tr class="even">
  51. <td width="25%" align="left" valign="top">
  52. Prototype
  53. </td>
  54. <td width="75%" align="left" valign="top">
  55. <b>
  56. void PMSM_Controller_initialize(RT_MODEL&nbsp;*const&nbsp;rtM)
  57. </b>
  58. </td>
  59. </tr>
  60. <tr class="odd">
  61. <td width="25%" align="left" valign="top">
  62. Description
  63. </td>
  64. <td width="75%" align="left" valign="top">
  65. Initialization entry point of generated code
  66. </td>
  67. </tr>
  68. <tr class="even">
  69. <td width="25%" align="left" valign="top">
  70. Timing
  71. </td>
  72. <td width="75%" align="left" valign="top">
  73. Must be called exactly once
  74. </td>
  75. </tr>
  76. <tr class="odd">
  77. <td width="25%" align="left" valign="top">
  78. Arguments
  79. </td>
  80. <td width="75%" align="left" valign="top">
  81. <table class="AltRow FirstColumn" cellspacing="0">
  82. <tr class="heading">
  83. <th align="left" valign="top">
  84. <b>
  85. #
  86. </b>
  87. </th>
  88. <th align="left" valign="top">
  89. <b>
  90. Name
  91. </b>
  92. </th>
  93. <th align="left" valign="top">
  94. <b>
  95. Data Type
  96. </b>
  97. </th>
  98. <th align="left" valign="top">
  99. <b>
  100. Description
  101. </b>
  102. </th>
  103. </tr>
  104. <tr class="even">
  105. <td align="right" valign="top">
  106. 1
  107. </td>
  108. <td align="left" valign="top">
  109. rtM
  110. </td>
  111. <td align="left" valign="top">
  112. RT_MODEL&nbsp;*const
  113. </td>
  114. <td align="left" valign="top">
  115. RTModel
  116. </td>
  117. </tr>
  118. </table>
  119. </td>
  120. </tr>
  121. <tr class="even">
  122. <td width="25%" align="left" valign="top">
  123. Return value
  124. </td>
  125. <td width="75%" align="left" valign="top">
  126. None
  127. </td>
  128. </tr>
  129. <tr class="odd">
  130. <td width="25%" align="left" valign="top">
  131. Header file
  132. </td>
  133. <td width="75%" align="left" valign="top">
  134. <a href="PMSM_Controller_h.html">PMSM_Controller.h</a>
  135. </td>
  136. </tr>
  137. </table>
  138. <p>
  139. Function: <a href="PMSM_Controller_c.html#fcn_PMSM_Controller_step">PMSM_Controller_step</a>
  140. </p>
  141. <table width="100%" class="AltRow" cellspacing="0">
  142. <tr class="even">
  143. <td width="25%" align="left" valign="top">
  144. Prototype
  145. </td>
  146. <td width="75%" align="left" valign="top">
  147. <b>
  148. void PMSM_Controller_step(RT_MODEL&nbsp;*const&nbsp;rtM, int16_T rtU_Vdc, uint16_T rtU_Ts, int16_T rtU_adc_a, int16_T rtU_adc_b, real_T rtU_rotor_angle, int16_T rtU_rotor_speed, int16_T rtU_input_target, uint16_T rtY_pwm_counts[8], uint8_T&nbsp;*rtY_sector)
  149. </b>
  150. </td>
  151. </tr>
  152. <tr class="odd">
  153. <td width="25%" align="left" valign="top">
  154. Description
  155. </td>
  156. <td width="75%" align="left" valign="top">
  157. Output entry point of generated code
  158. </td>
  159. </tr>
  160. <tr class="even">
  161. <td width="25%" align="left" valign="top">
  162. Timing
  163. </td>
  164. <td width="75%" align="left" valign="top">
  165. Must be called periodically, every 6.2e-06 seconds
  166. </td>
  167. </tr>
  168. <tr class="odd">
  169. <td width="25%" align="left" valign="top">
  170. Arguments
  171. </td>
  172. <td width="75%" align="left" valign="top">
  173. <span title="Click to shrink or expand table" onclick="rtwTableShrink(this)">[-]</span><table class="AltRow FirstColumn" cellspacing="0">
  174. <tr class="heading">
  175. <th align="left" valign="top">
  176. <b>
  177. #
  178. </b>
  179. </th>
  180. <th align="left" valign="top">
  181. <b>
  182. Name
  183. </b>
  184. </th>
  185. <th align="left" valign="top">
  186. <b>
  187. Data Type
  188. </b>
  189. </th>
  190. <th align="left" valign="top">
  191. <b>
  192. Scaling
  193. </b>
  194. </th>
  195. <th align="left" valign="top">
  196. <b>
  197. Description
  198. </b>
  199. </th>
  200. </tr>
  201. <tr class="even">
  202. <td align="right" valign="top">
  203. 1
  204. </td>
  205. <td align="left" valign="top">
  206. rtM
  207. </td>
  208. <td align="left" valign="top">
  209. RT_MODEL&nbsp;*const
  210. </td>
  211. <td align="left" valign="top">
  212. &#160;
  213. </td>
  214. <td align="left" valign="top">
  215. RTModel
  216. </td>
  217. </tr>
  218. <tr class="odd">
  219. <td align="right" valign="top">
  220. 2
  221. </td>
  222. <td align="left" valign="top">
  223. rtU_Vdc
  224. </td>
  225. <td align="left" valign="top">
  226. int16_T
  227. </td>
  228. <td align="left" valign="top">
  229. <span title=" DataTypeMode: Fixed-point: binary point scaling
  230. Signedness: Signed
  231. WordLength: 16
  232. FractionLength: 4
  233. ">sfix16_En4</span>
  234. </td>
  235. <td align="left" valign="top">
  236. &lt;S4&gt;/Vdc
  237. </td>
  238. </tr>
  239. <tr class="even">
  240. <td align="right" valign="top">
  241. 3
  242. </td>
  243. <td align="left" valign="top">
  244. rtU_Ts
  245. </td>
  246. <td align="left" valign="top">
  247. uint16_T
  248. </td>
  249. <td align="left" valign="top">
  250. &#160;
  251. </td>
  252. <td align="left" valign="top">
  253. &lt;S4&gt;/Ts
  254. </td>
  255. </tr>
  256. <tr class="odd">
  257. <td align="right" valign="top">
  258. 4
  259. </td>
  260. <td align="left" valign="top">
  261. rtU_adc_a
  262. </td>
  263. <td align="left" valign="top">
  264. int16_T
  265. </td>
  266. <td align="left" valign="top">
  267. &#160;
  268. </td>
  269. <td align="left" valign="top">
  270. &lt;S4&gt;/adc_a
  271. </td>
  272. </tr>
  273. <tr class="even">
  274. <td align="right" valign="top">
  275. 5
  276. </td>
  277. <td align="left" valign="top">
  278. rtU_adc_b
  279. </td>
  280. <td align="left" valign="top">
  281. int16_T
  282. </td>
  283. <td align="left" valign="top">
  284. &#160;
  285. </td>
  286. <td align="left" valign="top">
  287. &lt;S4&gt;/adc_b
  288. </td>
  289. </tr>
  290. <tr class="odd">
  291. <td align="right" valign="top">
  292. 6
  293. </td>
  294. <td align="left" valign="top">
  295. rtU_rotor_angle
  296. </td>
  297. <td align="left" valign="top">
  298. real_T
  299. </td>
  300. <td align="left" valign="top">
  301. &#160;
  302. </td>
  303. <td align="left" valign="top">
  304. &lt;S4&gt;/rotor_angle
  305. </td>
  306. </tr>
  307. <tr class="even">
  308. <td align="right" valign="top">
  309. 7
  310. </td>
  311. <td align="left" valign="top">
  312. rtU_rotor_speed
  313. </td>
  314. <td align="left" valign="top">
  315. int16_T
  316. </td>
  317. <td align="left" valign="top">
  318. &#160;
  319. </td>
  320. <td align="left" valign="top">
  321. &lt;S4&gt;/rotor_speed
  322. </td>
  323. </tr>
  324. <tr class="odd">
  325. <td align="right" valign="top">
  326. 8
  327. </td>
  328. <td align="left" valign="top">
  329. rtU_input_target
  330. </td>
  331. <td align="left" valign="top">
  332. int16_T
  333. </td>
  334. <td align="left" valign="top">
  335. &#160;
  336. </td>
  337. <td align="left" valign="top">
  338. &lt;S4&gt;/input_target
  339. </td>
  340. </tr>
  341. <tr class="even">
  342. <td align="right" valign="top">
  343. 9
  344. </td>
  345. <td align="left" valign="top">
  346. rtY_pwm_counts
  347. </td>
  348. <td align="left" valign="top">
  349. uint16_T
  350. </td>
  351. <td align="left" valign="top">
  352. &#160;
  353. </td>
  354. <td align="left" valign="top">
  355. &lt;S4&gt;/pwm_counts
  356. </td>
  357. </tr>
  358. <tr class="odd">
  359. <td align="right" valign="top">
  360. 10
  361. </td>
  362. <td align="left" valign="top">
  363. rtY_sector
  364. </td>
  365. <td align="left" valign="top">
  366. uint8_T&nbsp;*
  367. </td>
  368. <td align="left" valign="top">
  369. &#160;
  370. </td>
  371. <td align="left" valign="top">
  372. &lt;S4&gt;/sector
  373. </td>
  374. </tr>
  375. </table>
  376. </td>
  377. </tr>
  378. <tr class="even">
  379. <td width="25%" align="left" valign="top">
  380. Return value
  381. </td>
  382. <td width="75%" align="left" valign="top">
  383. None
  384. </td>
  385. </tr>
  386. <tr class="odd">
  387. <td width="25%" align="left" valign="top">
  388. Header file
  389. </td>
  390. <td width="75%" align="left" valign="top">
  391. <a href="PMSM_Controller_h.html">PMSM_Controller.h</a>
  392. </td>
  393. </tr>
  394. </table>
  395. <h3>
  396. <a name="sec_Inports">
  397. Inports
  398. </a>
  399. </h3>
  400. <span title="Click to shrink or expand table" onclick="rtwTableShrink(this)">[-]</span><table width="100%" class="AltRow FirstColumn" cellspacing="0">
  401. <tr class="heading">
  402. <th width="38%" align="left" valign="top">
  403. <b>
  404. Block Name
  405. </b>
  406. </th>
  407. <th width="23%" align="left" valign="top">
  408. <b>
  409. Code Identifier
  410. </b>
  411. </th>
  412. <th width="19%" align="left" valign="top">
  413. <b>
  414. Data Type
  415. </b>
  416. </th>
  417. <th width="9%" align="left" valign="top">
  418. <b>
  419. Scaling
  420. </b>
  421. </th>
  422. <th width="9%" align="right" valign="top">
  423. <b>
  424. Dimension
  425. </b>
  426. </th>
  427. </tr>
  428. <tr class="even">
  429. <td width="38%" align="left" valign="top">
  430. &lt;S4&gt;/Vdc
  431. </td>
  432. <td width="23%" align="left" valign="top">
  433. <i>
  434. Defined externally
  435. </i>
  436. </td>
  437. <td width="19%" align="left" valign="top">
  438. int16_T
  439. </td>
  440. <td width="9%" align="left" valign="top">
  441. <span title=" DataTypeMode: Fixed-point: binary point scaling
  442. Signedness: Signed
  443. WordLength: 16
  444. FractionLength: 4
  445. ">sfix16_En4</span>
  446. </td>
  447. <td width="9%" align="right" valign="top">
  448. 1
  449. </td>
  450. </tr>
  451. <tr class="odd">
  452. <td width="38%" align="left" valign="top">
  453. &lt;S4&gt;/Ts
  454. </td>
  455. <td width="23%" align="left" valign="top">
  456. <i>
  457. Defined externally
  458. </i>
  459. </td>
  460. <td width="19%" align="left" valign="top">
  461. uint16_T
  462. </td>
  463. <td width="9%" align="left" valign="top">
  464. &#160;
  465. </td>
  466. <td width="9%" align="right" valign="top">
  467. 1
  468. </td>
  469. </tr>
  470. <tr class="even">
  471. <td width="38%" align="left" valign="top">
  472. &lt;S4&gt;/adc_a
  473. </td>
  474. <td width="23%" align="left" valign="top">
  475. <i>
  476. Defined externally
  477. </i>
  478. </td>
  479. <td width="19%" align="left" valign="top">
  480. int16_T
  481. </td>
  482. <td width="9%" align="left" valign="top">
  483. &#160;
  484. </td>
  485. <td width="9%" align="right" valign="top">
  486. 1
  487. </td>
  488. </tr>
  489. <tr class="odd">
  490. <td width="38%" align="left" valign="top">
  491. &lt;S4&gt;/adc_b
  492. </td>
  493. <td width="23%" align="left" valign="top">
  494. <i>
  495. Defined externally
  496. </i>
  497. </td>
  498. <td width="19%" align="left" valign="top">
  499. int16_T
  500. </td>
  501. <td width="9%" align="left" valign="top">
  502. &#160;
  503. </td>
  504. <td width="9%" align="right" valign="top">
  505. 1
  506. </td>
  507. </tr>
  508. <tr class="even">
  509. <td width="38%" align="left" valign="top">
  510. &lt;S4&gt;/rotor_angle
  511. </td>
  512. <td width="23%" align="left" valign="top">
  513. <i>
  514. Defined externally
  515. </i>
  516. </td>
  517. <td width="19%" align="left" valign="top">
  518. real_T
  519. </td>
  520. <td width="9%" align="left" valign="top">
  521. &#160;
  522. </td>
  523. <td width="9%" align="right" valign="top">
  524. 1
  525. </td>
  526. </tr>
  527. <tr class="odd">
  528. <td width="38%" align="left" valign="top">
  529. &lt;S4&gt;/rotor_speed
  530. </td>
  531. <td width="23%" align="left" valign="top">
  532. <i>
  533. Defined externally
  534. </i>
  535. </td>
  536. <td width="19%" align="left" valign="top">
  537. int16_T
  538. </td>
  539. <td width="9%" align="left" valign="top">
  540. &#160;
  541. </td>
  542. <td width="9%" align="right" valign="top">
  543. 1
  544. </td>
  545. </tr>
  546. <tr class="even">
  547. <td width="38%" align="left" valign="top">
  548. &lt;S4&gt;/input_target
  549. </td>
  550. <td width="23%" align="left" valign="top">
  551. <i>
  552. Defined externally
  553. </i>
  554. </td>
  555. <td width="19%" align="left" valign="top">
  556. int16_T
  557. </td>
  558. <td width="9%" align="left" valign="top">
  559. &#160;
  560. </td>
  561. <td width="9%" align="right" valign="top">
  562. 1
  563. </td>
  564. </tr>
  565. <tr class="odd">
  566. <td width="38%" align="left" valign="top">
  567. &lt;S4&gt;/hall_a
  568. </td>
  569. <td width="23%" align="left" valign="top">
  570. <i>
  571. Defined externally
  572. </i>
  573. </td>
  574. <td width="19%" align="left" valign="top">
  575. uint8_T
  576. </td>
  577. <td width="9%" align="left" valign="top">
  578. &#160;
  579. </td>
  580. <td width="9%" align="right" valign="top">
  581. 1
  582. </td>
  583. </tr>
  584. <tr class="even">
  585. <td width="38%" align="left" valign="top">
  586. &lt;S4&gt;/hall_b
  587. </td>
  588. <td width="23%" align="left" valign="top">
  589. <i>
  590. Defined externally
  591. </i>
  592. </td>
  593. <td width="19%" align="left" valign="top">
  594. uint8_T
  595. </td>
  596. <td width="9%" align="left" valign="top">
  597. &#160;
  598. </td>
  599. <td width="9%" align="right" valign="top">
  600. 1
  601. </td>
  602. </tr>
  603. <tr class="odd">
  604. <td width="38%" align="left" valign="top">
  605. &lt;S4&gt;/hall_c
  606. </td>
  607. <td width="23%" align="left" valign="top">
  608. <i>
  609. Defined externally
  610. </i>
  611. </td>
  612. <td width="19%" align="left" valign="top">
  613. uint8_T
  614. </td>
  615. <td width="9%" align="left" valign="top">
  616. &#160;
  617. </td>
  618. <td width="9%" align="right" valign="top">
  619. 1
  620. </td>
  621. </tr>
  622. <tr class="even">
  623. <td width="38%" align="left" valign="top">
  624. &lt;S4&gt;/hw_count
  625. </td>
  626. <td width="23%" align="left" valign="top">
  627. <i>
  628. Defined externally
  629. </i>
  630. </td>
  631. <td width="19%" align="left" valign="top">
  632. uint32_T
  633. </td>
  634. <td width="9%" align="left" valign="top">
  635. &#160;
  636. </td>
  637. <td width="9%" align="right" valign="top">
  638. 1
  639. </td>
  640. </tr>
  641. <tr class="odd">
  642. <td width="38%" align="left" valign="top">
  643. &lt;S4&gt;/b_motor_enable
  644. </td>
  645. <td width="23%" align="left" valign="top">
  646. <i>
  647. Defined externally
  648. </i>
  649. </td>
  650. <td width="19%" align="left" valign="top">
  651. boolean_T
  652. </td>
  653. <td width="9%" align="left" valign="top">
  654. &#160;
  655. </td>
  656. <td width="9%" align="right" valign="top">
  657. 1
  658. </td>
  659. </tr>
  660. <tr class="even">
  661. <td width="38%" align="left" valign="top">
  662. &lt;S4&gt;/b_cruise_enable
  663. </td>
  664. <td width="23%" align="left" valign="top">
  665. <i>
  666. Defined externally
  667. </i>
  668. </td>
  669. <td width="19%" align="left" valign="top">
  670. boolean_T
  671. </td>
  672. <td width="9%" align="left" valign="top">
  673. &#160;
  674. </td>
  675. <td width="9%" align="right" valign="top">
  676. 1
  677. </td>
  678. </tr>
  679. <tr class="odd">
  680. <td width="38%" align="left" valign="top">
  681. &lt;S4&gt;/n_ctrl_type
  682. </td>
  683. <td width="23%" align="left" valign="top">
  684. <i>
  685. Defined externally
  686. </i>
  687. </td>
  688. <td width="19%" align="left" valign="top">
  689. uint8_T
  690. </td>
  691. <td width="9%" align="left" valign="top">
  692. &#160;
  693. </td>
  694. <td width="9%" align="right" valign="top">
  695. 1
  696. </td>
  697. </tr>
  698. </table>
  699. <h3>
  700. <a name="sec_Outports">
  701. Outports
  702. </a>
  703. </h3>
  704. <table width="100%" class="AltRow FirstColumn" cellspacing="0">
  705. <tr class="heading">
  706. <th width="42%" align="left" valign="top">
  707. <b>
  708. Block Name
  709. </b>
  710. </th>
  711. <th width="26%" align="left" valign="top">
  712. <b>
  713. Code Identifier
  714. </b>
  715. </th>
  716. <th width="21%" align="left" valign="top">
  717. <b>
  718. Data Type
  719. </b>
  720. </th>
  721. <th width="10%" align="right" valign="top">
  722. <b>
  723. Dimension
  724. </b>
  725. </th>
  726. </tr>
  727. <tr class="even">
  728. <td width="42%" align="left" valign="top">
  729. &lt;S4&gt;/pwm_counts
  730. </td>
  731. <td width="26%" align="left" valign="top">
  732. <i>
  733. Defined externally
  734. </i>
  735. </td>
  736. <td width="21%" align="left" valign="top">
  737. uint16_T
  738. </td>
  739. <td width="10%" align="right" valign="top">
  740. [8]
  741. </td>
  742. </tr>
  743. <tr class="odd">
  744. <td width="42%" align="left" valign="top">
  745. &lt;S4&gt;/sector
  746. </td>
  747. <td width="26%" align="left" valign="top">
  748. <i>
  749. Defined externally
  750. </i>
  751. </td>
  752. <td width="21%" align="left" valign="top">
  753. uint8_T
  754. </td>
  755. <td width="10%" align="right" valign="top">
  756. 1
  757. </td>
  758. </tr>
  759. </table>
  760. <h3>
  761. <a name="sec_Interface_Parameters">
  762. Interface Parameters
  763. </a>
  764. </h3>
  765. <p>
  766. No interface/tunable parameters in model.
  767. </p>
  768. <h3>
  769. <a name="sec_Data_Stores">
  770. Data Stores
  771. </a>
  772. </h3>
  773. <p>
  774. No data stores in the model; note that this report lists only data stores with non-auto storage class and global data stores
  775. </p>
  776. </body>
  777. </html>