MSPM0G3507SensorlessFOCMotorControlLibrary  1.0
focHALInterface.h
Go to the documentation of this file.
1 /* --COPYRIGHT--,TI
2  * MSP Source and Object Code Software License Agreement
3  *
4  *
5  * IMPORTANT - PLEASE CAREFULLY READ THE FOLLOWING LICENSE AGREEMENT, WHICH IS LEGALLY BINDING. AFTER YOU READ IT, YOU WILL BE ASKED WHETHER YOU ACCEPT AND AGREE TO ITS TERMS. DO NOT CLICK "I ACCEPT" UNLESS: (1) YOU WILL USE THE LICENSED MATERIALS FOR YOUR OWN BENEFIT AND PERSONALLY ACCEPT, AGREE TO AND INTEND TO BE BOUND BY THESE TERMS; OR (2) YOU ARE AUTHORIZED TO, AND INTEND TO BE BOUND BY, THESE TERMS ON BEHALF OF YOUR COMPANY.
6  *
7  *
8  * Important - Read carefully: This Source and Object Code Software License Agreement ("Agreement") is a legal agreement between you and Texas Instruments Incorporated ("TI"). In this Agreement "you" means you personally if you will exercise the rights granted for your own benefit, but it means your company (or you on behalf of your company) if you will exercise the rights granted for your company's benefit. The "Licensed Materials" subject to this Agreement include the software programs and any associated electronic documentation (in each case, in whole or in part) that accompany this Agreement, are set forth in the applicable software manifest and you access "on-line", as well as any updates or upgrades to such software programs or documentation, if any, provided to you at TI's sole discretion. The Licensed Materials are specifically designed and licensed for use solely and exclusively with MSP microcontroller devices manufactured by or for TI ("TI Devices"). By installing, copying or otherwise using the Licensed Materials you agree to abide by the provisions set forth herein. This Agreement is displayed for you to read prior to using the Licensed Materials. If you choose not to accept or agree with these provisions, do not download or install the Licensed Materials.
9  *
10  * Note Regarding Possible Access to Other Licensed Materials: The Licensed Materials may be bundled with software and associated electronic documentation, if any, licensed under terms other than the terms of this Agreement (in whole or in part, "Other Licensed Materials"), including, for example Open Source Software and/or TI-owned or third party Proprietary Software licensed under such other terms. "Open Source Software" means any software licensed under terms requiring that (A) other software ("Proprietary Software") incorporated, combined or distributed with such software or developed using such software: (i) be disclosed or distributed in source code form; or (ii) otherwise be licensed on terms inconsistent with the terms of this Agreement, including but not limited to permitting use of the Proprietary Software on or with devices other than TI Devices, or (B) require the owner of Proprietary Software to license any of its patents to users of the Open Source Software and/or Proprietary Software incorporated, combined or distributed with such Open Source Software or developed using such Open Source Software.
11  *
12  * If by accepting this Agreement, you gain access to Other Licensed Materials, they will be listed in the applicable software manifest. Your use of the Other Licensed Materials is subject to the applicable other licensing terms acknowledgements and disclaimers as specified in the applicable software manifest and/or identified or included with the Other Licensed Materials in the software bundle. For clarification, this Agreement does not limit your rights under, or grant you rights that supersede, the terms of any applicable Other Licensed Materials license agreement. If any of the Other Licensed Materials is Open Source Software that has been provided to you in object code only under terms that obligate TI to provide to you or show you where you can access the source code versions of such Open Source Software, TI will provide to you, or show you where you can access, such source code if you contact TI at Texas Instruments Incorporated, 12500 TI Boulevard, Mail Station 8638, Dallas, Texas 75243, Attention: Contracts Manager, Embedded Processing. In the event you choose not to accept or agree with the terms in any applicable Other Licensed Materials license agreement, you must terminate this Agreement.
13  *
14  * 1. License Grant and Use Restrictions.
15  *
16  * a. Licensed Materials License Grant. Subject to the terms of this Agreement, TI hereby grants to you a limited, non-transferable, non-exclusive, non-assignable, non-sublicensable, fully paid-up and royalty-free license to:
17  *
18  * i. Limited Source Code License: make copies, prepare derivative works, display internally and use internally the Licensed Materials provided to you in source code for the sole purpose of developing object and executable versions of such Licensed Materials, or any derivative thereof, that execute solely and exclusively on TI Devices, for end use in Licensee Products, and maintaining and supporting such Licensed Materials, or any derivative thereof, and Licensee Products. For purposes of this Agreement, "Licensee Product" means a product that consists of both hardware, including one or more TI Devices, and software components, including only executable versions of the Licensed Materials that execute solely and exclusively on such TI Devices.
19  *
20  * ii. Object Code Evaluation, Testing and Use License: make copies, display internally, distribute internally and use internally the Licensed Materials in object code for the sole purposes of evaluating and testing the Licensed Materials and designing and developing Licensee Products, and maintaining and supporting the Licensee Products;
21  *
22  * iii. Demonstration License: demonstrate to third parties the Licensed Materials executing solely and exclusively on TI Devices as they are used in Licensee Products, provided that such Licensed Materials are demonstrated in object or executable versions only and
23  *
24  * iv. Production and Distribution License: make, use, import, export and otherwise distribute the Licensed Materials as part of a Licensee Product, provided that such Licensee Products include only embedded executable copies of such Licensed Materials that execute solely and exclusively on TI Devices.
25  *
26  * b. Contractors. The licenses granted to you hereunder shall include your on-site and off-site contractors (either an individual or entity), while such contractors are performing work for or providing services to you, provided that such contractors have executed work-for-hire agreements with you containing applicable terms and conditions consistent with the terms and conditions set forth in this Agreement and provided further that you shall be liable to TI for any breach by your contractors of this Agreement to the same extent as you would be if you had breached the Agreement yourself.
27  *
28  * c. No Other License. Nothing in this Agreement shall be construed as a license to any intellectual property rights of TI other than those rights embodied in the Licensed Materials provided to you by TI. EXCEPT AS PROVIDED HEREIN, NO OTHER LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY OTHER TI INTELLECTUAL PROPERTY RIGHTS IS GRANTED HEREIN.
29  *
30  * d. Covenant not to Sue. During the term of this Agreement, you agree not to assert a claim against TI or its licensees that the Licensed Materials infringe your intellectual property rights.
31  *
32  * e. Restrictions. You shall maintain the source code versions of the Licensed Materials under password control protection and shall not disclose such source code versions of the Licensed Materials, to any person other than your employees and contractors whose job performance requires access. You shall not use the Licensed Materials with a processing device other than a TI Device, and you agree that any such unauthorized use of the Licensed Materials is a material breach of this Agreement. You shall not use the Licensed Materials for the purpose of analyzing or proving infringement of any of your patents by either TI or TI's customers. Except as expressly provided in this Agreement, you shall not copy, publish, disclose, display, provide, transfer or make available the Licensed Materials to any third party and you shall not sublicense, transfer, or assign the Licensed Materials or your rights under this Agreement to any third party. You shall not mortgage, pledge or encumber the Licensed Materials in any way. You may use the Licensed Materials with Open Source Software or with software developed using Open Source Software tools provided you do not incorporate, combine or distribute the Licensed Materials in a manner that subjects the Licensed Materials to any license obligations or any other intellectual property related terms of any license governing such Open Source Software.
33  *
34  * f. Termination. This Agreement is effective on the date the Licensed Materials are delivered to you together with this Agreement and will remain in full force and effect until terminated. You may terminate this Agreement at any time by written notice to TI. Without prejudice to any other rights, if you fail to comply with the terms of this Agreement or you are acquired, TI may terminate your right to use the Licensed Materials upon written notice to you. Upon termination of this Agreement, you will destroy any and all copies of the Licensed Materials in your possession, custody or control and provide to TI a written statement signed by your authorized representative certifying such destruction. Except for Sections 1(a), 1(b) and 1(d), all provisions of this Agreement shall survive termination of this Agreement.
35  *
36  * 2. Licensed Materials Ownership. The Licensed Materials are licensed, not sold to you, and can only be used in accordance with the terms of this Agreement. Subject to the licenses granted to you pursuant to this Agreement, TI and its licensors own and shall continue to own all right, title and interest in and to the Licensed Materials, including all copies thereof. You agree that all fixes, modifications and improvements to the Licensed Materials conceived of or made by TI that are based, either in whole or in part, on your feedback, suggestions or recommendations are the exclusive property of TI and all right, title and interest in and to such fixes, modifications or improvements to the Licensed Materials will vest solely in TI. Moreover, you acknowledge and agree that when your independently developed software or hardware components are combined, in whole or in part, with the Licensed Materials, your right to use the combined work that includes the Licensed Materials remains subject to the terms and conditions of this Agreement.
37  *
38  * 3. Intellectual Property Rights.
39  *
40  * a. The Licensed Materials contain copyrighted material, trade secrets and other proprietary information of TI and its licensors and are protected by copyright laws, international copyright treaties, and trade secret laws, as well as other intellectual property laws. To protect TI's and its licensors' rights in the Licensed Materials, you agree, except as specifically permitted by statute by a provision that cannot be waived by contract, not to "unlock", decompile, reverse engineer, disassemble or otherwise translate to a human-perceivable form any portions of the Licensed Materials provided to you in object code format only, nor permit any person or entity to do so. You shall not remove, alter, cover, or obscure any confidentiality, trade secret, trade mark, patent, copyright or other proprietary notice or other identifying marks or designs from any component of the Licensed Materials and you shall reproduce and include in all copies of the Licensed Materials the copyright notice(s) and proprietary legend(s) of TI and its licensors as they appear in the Licensed Materials. TI reserves all rights not specifically granted under this Agreement.
41  *
42  * b. Certain Licensed Materials may be based on industry recognized standards or software programs published by industry recognized standards bodies and certain third parties may claim to own patents, copyrights, and other intellectual property rights that cover implementation of those standards. You acknowledge and agree that this Agreement does not convey a license to any such third party patents, copyrights, and other intellectual property rights and that you are solely responsible for any patent, copyright, or other intellectual property right claim that relates to your use or distribution of the Licensed Materials or your use or distribution of your products that include or incorporate the Licensed Materials. Moreover, you acknowledge that you are responsible for any fees or royalties that may be payable to any third party based on such third party's interests in the Licensed Materials or any intellectual property rights that cover implementation of any industry recognized standard, any software program published by any industry recognized standards bodies or any other proprietary technology.
43  *
44  * 4. Confidential Information. You acknowledge and agree that the Licensed Materials contain trade secrets and other confidential information of TI and its licensors. You agree to use the Licensed Materials solely within the scope of the licenses set forth herein, to maintain the Licensed Materials in strict confidence, to use at least the same procedures and degree of care that you use to prevent disclosure of your own confidential information of like importance but in no instance less than reasonable care, and to prevent disclosure of the Licensed Materials to any third party, except as may be necessary and required in connection with your rights and obligations hereunder; provided, however, that you may not provide the Licensed Materials to any business organization or group within your company or to customers or contractors that design or manufacture semiconductors unless TI gives written consent. You agree to obtain executed confidentiality agreements with your employees and contractors having access to the Licensed Materials and to diligently take steps to enforce such agreements in this respect. TI may disclose your contact information to TI's licensors.
45  *
46  * 5. Warranties and Limitations. THE LICENSED MATERIALS ARE PROVIDED "AS IS". FURTHERMORE, YOU ACKNOWLEDGE AND AGREE THAT THE LICENSED MATERIALS HAVE NOT BEEN TESTED OR CERTIFIED BY ANY GOVERNMENT AGENCY OR INDUSTRY REGULATORY ORGANIZATION OR ANY OTHER THIRD PARTY ORGANIZATION. YOU AGREE THAT PRIOR TO USING, INCORPORATING OR DISTRIBUTING THE LICENSED MATERIALS IN OR WITH ANY COMMERCIAL PRODUCT THAT YOU WILL THOROUGHLY TEST THE PRODUCT AND THE FUNCTIONALITY OF THE LICENSED MATERIALS IN OR WITH THAT PRODUCT AND BE SOLELY RESPONSIBLE FOR ANY PROBLEMS OR FAILURES.
47  *
48  * TI AND ITS LICENSORS MAKE NO WARRANTY OR REPRESENTATION, EITHER EXPRESS, IMPLIED OR STATUTORY, REGARDING THE LICENSED MATERIALS, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT OF ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADE SECRETS OR OTHER INTELLECTUAL PROPERTY RIGHTS. YOU AGREE TO USE YOUR INDEPENDENT JUDGMENT IN DEVELOPING YOUR PRODUCTS. NOTHING CONTAINED IN THIS AGREEMENT WILL BE CONSTRUED AS A WARRANTY OR REPRESENTATION BY TI TO MAINTAIN PRODUCTION OF ANY TI SEMICONDUCTOR DEVICE OR OTHER HARDWARE OR SOFTWARE WITH WHICH THE LICENSED MATERIALS MAY BE USED.
49  *
50  * IN NO EVENT SHALL TI OR ITS LICENSORS, BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED, ON ANY THEORY OF LIABILITY, IN CONNECTION WITH OR ARISING OUT OF THIS AGREEMENT OR THE USE OF THE LICENSED MATERIALS REGARDLESS OF WHETHER TI HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. EXCLUDED DAMAGES INCLUDE, BUT ARE NOT LIMITED TO, COST OF REMOVAL OR REINSTALLATION, OUTSIDE COMPUTER TIME, LABOR COSTS, LOSS OF DATA, LOSS OF GOODWILL, LOSS OF PROFITS, LOSS OF SAVINGS, OR LOSS OF USE OR INTERRUPTION OF BUSINESS. IN NO EVENT WILL TI'S OR ITS LICENSORS' AGGREGATE LIABILITY UNDER THIS AGREEMENT OR ARISING OUT OF YOUR USE OF THE LICENSED MATERIALS EXCEED FIVE HUNDRED U.S. DOLLARS (US$500).
51  *
52  * Because some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages or limitation on how long an implied warranty lasts, the above limitations or exclusions may not apply to you.
53  *
54  * 6. Indemnification Disclaimer. YOU ACKNOWLEDGE AND AGREE THAT TI SHALL NOT BE LIABLE FOR AND SHALL NOT DEFEND OR INDEMNIFY YOU AGAINST ANY THIRD PARTY INFRINGEMENT CLAIM THAT RELATES TO OR IS BASED ON YOUR MANUFACTURE, USE, OR DISTRIBUTION OF THE LICENSED MATERIALS OR YOUR MANUFACTURE, USE, OFFER FOR SALE, SALE, IMPORTATION OR DISTRIBUTION OF YOUR PRODUCTS THAT INCLUDE OR INCORPORATE THE LICENSED MATERIALS.
55  *
56  * 7. No Technical Support. TI and its licensors are under no obligation to install, maintain or support the Licensed Materials.
57  *
58  * 8. Notices. All notices to TI hereunder shall be delivered to Texas Instruments Incorporated, 12500 TI Boulevard, Mail Station 8638, Dallas, Texas 75243, Attention: Contracts Manager - Embedded Processing, with a copy to Texas Instruments Incorporated, 13588 N. Central Expressway, Mail Station 3999, Dallas, Texas 75243, Attention: Law Department - Embedded Processing. All notices shall be deemed served when received by TI.
59  *
60  * 9. Export Control. The Licensed Materials are subject to export control under the U.S. Commerce Department's Export Administration Regulations ("EAR"). Unless prior authorization is obtained from the U.S. Commerce Department, neither you nor your subsidiaries shall export, re-export, or release, directly or indirectly (including, without limitation, by permitting the Licensed Materials to be downloaded), any technology, software, or software source code, received from TI, or export, directly or indirectly, any direct product of such technology, software, or software source code, to any person, destination or country to which the export, re-export, or release of the technology, software, or software source code, or direct product is prohibited by the EAR. You represent and warrant that you (i) are not located in, or under the control of, a national or resident of Cuba, Iran, North Korea, Sudan and Syria or any other country subject to a U.S. goods embargo; (ii) are not on the U.S. Treasury Department's List of Specially Designated Nationals or the U.S. Commerce Department's Denied Persons List or Entity List; and (iii) will not use the Licensed Materials or transfer the Licensed Materials for use in any military, nuclear, chemical or biological weapons, or missile technology end-uses. Any software export classification made by TI shall not be construed as a representation or warranty regarding the proper export classification for such software or whether an export license or other documentation is required for the exportation of such software.
61  *
62  * 10. Governing Law and Severability; Waiver. This Agreement will be governed by and interpreted in accordance with the laws of the State of Texas, without reference to conflict of laws principles. If for any reason a court of competent jurisdiction finds any provision of the Agreement to be unenforceable, that provision will be enforced to the maximum extent possible to effectuate the intent of the parties, and the remainder of the Agreement shall continue in full force and effect. This Agreement shall not be governed by the United Nations Convention on Contracts for the International Sale of Goods, or by the Uniform Computer Information Transactions Act (UCITA). The parties agree that non-exclusive jurisdiction for any dispute arising out of or relating to this Agreement lies within the courts located in the State of Texas. Notwithstanding the foregoing, any judgment may be enforced in any United States or foreign court, and either party may seek injunctive relief in any United States or foreign court. Failure by TI to enforce any provision of this Agreement shall not be deemed a waiver of future enforcement of that or any other provision in this Agreement or any other agreement that may be in place between the parties.
63  *
64  * 11. PRC Provisions. If you are located in the People's Republic of China ("PRC") or if the Licensed Materials will be sent to the PRC, the following provisions shall apply:
65  *
66  * a. Registration Requirements. You shall be solely responsible for performing all acts and obtaining all approvals that may be required in connection with this Agreement by the government of the PRC, including but not limited to registering pursuant to, and otherwise complying with, the PRC Measures on the Administration of Software Products, Management Regulations on Technology Import-Export, and Technology Import and Export Contract Registration Management Rules. Upon receipt of such approvals from the government authorities, you shall forward evidence of all such approvals to TI for its records. In the event that you fail to obtain any such approval or registration, you shall be solely responsible for any and all losses, damages or costs resulting therefrom, and shall indemnify TI for all such losses, damages or costs.
67  *
68  * b. Governing Language. This Agreement is written and executed in the English language and shall be authoritative and controlling, whether or not translated into a language other than English to comply with law or for reference purposes. If a translation of this Agreement is required for any purpose, including but not limited to registration of the Agreement pursuant to any governmental laws, regulations or rules, you shall be solely responsible for creating such translation.
69  *
70  * 12. Contingencies. TI shall not be in breach of this Agreement and shall not be liable for any non-performance or delay in performance if such non-performance or delay is due to a force majeure event or other circumstances beyond TI's reasonable control.
71  *
72  * 13. Entire Agreement. This is the entire agreement between you and TI and this Agreement supersedes any prior agreement between the parties related to the subject matter of this Agreement. Notwithstanding the foregoing, any signed and effective software license agreement relating to the subject matter hereof and stating expressly that such agreement shall control regardless of any subsequent click-wrap, shrink-wrap or web-wrap, shall supersede the terms of this Agreement. No amendment or modification of this Agreement will be effective unless in writing and signed by a duly authorized representative of TI. You hereby warrant and represent that you have obtained all authorizations and other applicable consents required empowering you to enter into this Agreement.
73  *
74  * --/COPYRIGHT--*/
75 /*!****************************************************************************
76  * @file focHALInterface.h
77  * @brief HAL interface for FOC Module
78  *
79  *
80  * @anchor focHALInterface_h
81  * # Overview
82  *
83  * HAL Apis used by FOC motor control
84  *
85  * <hr>
86  ******************************************************************************/
87 
88 #ifndef FOC_HAL_INTERFACE_H
89 #define FOC_HAL_INTERFACE_H
90 
91 #ifdef __cplusplus
92 extern "C" {
93 #endif
94 
95 /* Including all the sysconfig generated defines */
96 #include "ti_msp_dl_config.h"
97 
98 /* Include the IQmath Library */
99 #include <ti/iqmath/include/IQmathLib.h>
100 
101 /* Include the mathacl optimized IQmath */
102 #include "IQmath_mathacl.h"
103 
104 #include "focPeriphInit.h"
105 #include "gateDriver.h"
106 
107 #include "stdint.h"
108 #include "measure.h"
109 #include "mcLib.h"
110 #include "main.h"
111 #include "iqNum.h"
112 #include "appInterface.h"
113 
115 #define MIN_FLOAT_VOLTAGE (0.1)
116 
118 #define MAX_FLOAT_VOLTAGE (0.9)
119 
123 #define HAL_MCU_CLK_SPEED_HZ (80000000)
124 
128 #define HAL_CYCLES_TO_1_US_DELAY (HAL_MCU_CLK_SPEED_HZ/1000000)
129 
133 #define HAL_GPIO_HIGH (1)
134 
138 #define HAL_GPIO_LOW (0)
139 
141 typedef enum
142 {
158 
164 
170 
177 void HAL_setADCIdxChannel(ADC12_Regs *adc12, DL_ADC12_MEM_IDX idx, uint32_t chansel);
178 
184 
190 
195 void HAL_ReadCurrents(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs);
196 
202 
206 void HAL_EnablePWM(void);
207 
211 void HAL_DisablePWM(void);
212 
216 void HAL_EnableLowSideBrake(void);
217 
226 void HAL_UpdateDuty(const MC_ABC_T *pABC, const int32_t FullDuty,
227  MC_SECTOR_TYPES voltageSector,
228  int32_t minDelta,
229  int32_t blankingTime);
230 
236 void HAL_SetPWMFrequency(const int32_t pwmPeriod,
237  const int32_t propagationDelay);
238 
242 void HAL_enterIPDMode();
243 
247 void HAL_exitIPDMode();
248 
253 void HAL_SetADCSamplingFrequency(const ADC_SAMPLING_RATIO_TYPES samplingRatio);
254 
259 void HAL_SetSystemFrequency(const int32_t systemPeriod);
260 
270 
274 void HAL_ClearNFault(void);
275 
279 void HAL_SetNFault(void);
280 
285 uint32_t HAL_getRawHVdieFaultStatus(void);
286 
291 uint32_t HAL_getRawFaultStatus(void);
292 
296 void HAL_clearFaultStatus(void);
297 
301 void HAL_setGateDriveOffsetCalib(void);
302 
307 
311 void HAL_pwmCountZero(void);
312 
317 void HAL_delayMicroSeconds(uint32_t num_us);
318 
322 void HAL_DisableINT(void);
323 
327 void HAL_resetPOR(void);
328 
336 _Bool HAL_getDirPinStatus(void);
337 
346 _Bool HAL_getBrakePinStatus(void);
347 
355 __STATIC_INLINE void HAL_TimerOverRideCCPOut(GPTIMER_Regs *gptimer, DL_TIMER_FORCE_OUT out,
356  DL_TIMER_FORCE_CMPL_OUT outComp, DL_TIMER_CC_INDEX ccIndex)
357 {
358  volatile uint32_t *pReg;
359 
360  pReg = &gptimer->COUNTERREGS.CCACT_01[0];
361  pReg += (uint32_t) ccIndex;
362 
363  DL_Common_updateReg(pReg, ((uint32_t) out | ((uint32_t) outComp)),
364  (GPTIMER_CCACT_01_SWFRCACT_CMPL_MASK |
365  GPTIMER_CCACT_01_SWFRCACT_MASK));
366 }
370 __STATIC_INLINE void HAL_FGToggle(void)
371 {
372 #ifdef FG_OUTPUT_ENABLE
373  DL_GPIO_togglePins(FOC_GPIO_OUT_FG_TOGGLE_PORT,FOC_GPIO_OUT_FG_TOGGLE_PIN);
374 #endif
375 }
380 __STATIC_INLINE void HAL_PWMForceHigh(DL_TIMER_CC_INDEX CCIdx)
381 {
382  HAL_TimerOverRideCCPOut(FOC_PWMA0_INST, DL_TIMER_FORCE_OUT_HIGH,
383  DL_TIMER_FORCE_CMPL_OUT_LOW, CCIdx);
384 }
385 
390 __STATIC_INLINE void HAL_PWMForceLow(DL_TIMER_CC_INDEX CCIdx)
391 {
392  HAL_TimerOverRideCCPOut(FOC_PWMA0_INST, DL_TIMER_FORCE_OUT_LOW,
393  DL_TIMER_FORCE_CMPL_OUT_HIGH, CCIdx);
394 }
395 
400 __STATIC_INLINE void HAL_PWMForceDisable(DL_TIMER_CC_INDEX CCIdx)
401 {
402  HAL_TimerOverRideCCPOut(FOC_PWMA0_INST, DL_TIMER_FORCE_OUT_DISABLED,
403  DL_TIMER_FORCE_CMPL_OUT_DISABLED, CCIdx);
404 }
405 
409 __STATIC_INLINE void HAL_PWMAllForceDisable()
410 {
411  HAL_PWMForceDisable(FOC_PWMA0_U_IDX);
412  HAL_PWMForceDisable(FOC_PWMA0_V_IDX);
413  HAL_PWMForceDisable(FOC_PWMA0_W_IDX);
414 }
415 
419 __STATIC_INLINE void HAL_PWMAllForceLow()
420 {
421  HAL_PWMForceLow(FOC_PWMA0_U_IDX);
422  HAL_PWMForceLow(FOC_PWMA0_V_IDX);
423  HAL_PWMForceLow(FOC_PWMA0_W_IDX);
424 }
425 
429 void HAL_IPDEnableISR(void);
430 
434 void HAL_IPDDisableISR(void);
435 
440 uint16_t HAL_IPDGetTime(void);
441 
446 uint16_t HAL_IPDGetLoadVal(void);
447 
452 uint16_t HAL_Is_SingleShunt(void);
453 
457 void HAL_IPDCOMPDACSetZero(void);
458 
465 void HAL_setIPDPulseConfig(VOLTAGE_VECTOR vector, uint8_t CompVal, CURRENT_OFFSET_T* pOffset);
466 
471 __STATIC_INLINE void HAL_ADCDisConv(ADC12_Regs *adc12)
472 {
473  adc12->ULLMEM.CTL0 &= ~(ADC12_CTL0_ENC_ON);
474 }
475 
480 __STATIC_INLINE void HAL_ADCEnConv(ADC12_Regs *adc12)
481 {
482  adc12->ULLMEM.CTL0 |= (ADC12_CTL0_ENC_ON);
483 }
484 
490 __STATIC_INLINE void HAL_ADCEnWCOMP(ADC12_Regs *adc12, DL_ADC12_MEM_IDX idx)
491 {
492  /* To update the window comparator enable/disable we need to disable the ADC*/
493  adc12->ULLMEM.MEMCTL[idx] |= DL_ADC12_WINDOWS_COMP_MODE_ENABLED;
494 }
500 __STATIC_INLINE void HAL_ADCDisWCOMP(ADC12_Regs *adc12, DL_ADC12_MEM_IDX idx)
501 {
502  /* To update the window comparator enable/disable we need to */
503  adc12->ULLMEM.MEMCTL[idx] &= ~DL_ADC12_WINDOWS_COMP_MODE_ENABLED;
504 }
505 
510 __STATIC_INLINE void HAL_enableTriggerFault(GPTIMER_Regs *gptimer)
511 {
512  gptimer->COUNTERREGS.FCTL |= GPTIMER_FCTL_TFIM_MASK;
513 }
514 
519 __STATIC_INLINE void HAL_disableTriggerFault(GPTIMER_Regs *gptimer)
520 {
521  gptimer->COUNTERREGS.FCTL &= ~GPTIMER_FCTL_TFIM_MASK;
522 }
523 
530 __STATIC_INLINE void HAL_setCaptureCompareValue(
531  GPTIMER_Regs *gptimer, uint32_t value, DL_TIMER_CC_INDEX ccIndex)
532 {
533  volatile uint32_t *pReg;
534 
535  pReg = &gptimer->COUNTERREGS.CC_01[0];
536  pReg += (uint32_t) ccIndex;
537 
538  *pReg = (value);
539 }
540 #ifdef __cplusplus
541 }
542 #endif
543 #endif /* FOC_HAL_INTERFACE_H */
Current offset structure.
Definition: measure.h:183
__STATIC_INLINE void HAL_disableTriggerFault(GPTIMER_Regs *gptimer)
Disable trigger fault for a timer.
Definition: focHALInterface.h:519
Measure voltage structure.
Definition: measure.h:310
void HAL_enterIPDMode()
Configures the peripherals for IPD.
Definition: focHALInterface.c:810
void HAL_EnableLowSideBrake(void)
Turns all low side PWM outputs high.
Definition: focHALInterface.c:359
_Bool HAL_GetPhasesFloatingStatus(const HAL_MEASURE_VOLTAGE_T *pVoltage)
Get phase floating status.
Definition: focHALInterface.c:891
void HAL_pwmCountZero(void)
Set PWMs to zero.
Definition: focHALInterface.c:964
uint16_t HAL_IPDGetLoadVal(void)
Returns the IPD load value.
Definition: focHALInterface.c:1403
VOLTAGE_VECTOR
VOLTAGE_VECTOR.
Definition: focHALInterface.h:141
Measure motor inputs structure.
Definition: measure.h:335
Definition: focHALInterface.h:150
void HAL_IPDDisableISR(void)
Disabled the IPD capture timer.
Definition: focHALInterface.c:1387
void HAL_SelectShuntMeasure(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs)
Select two shunt if duty saturates in any phases.
Definition: focHALInterface.c:278
void HAL_DisableINT(void)
Disables all the interrupts.
Definition: focHALInterface.c:993
void HAL_ReadPhaseVoltages(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs)
Read Phase voltages from ADCs.
Definition: focHALInterface.c:158
__STATIC_INLINE void HAL_ADCDisWCOMP(ADC12_Regs *adc12, DL_ADC12_MEM_IDX idx)
Disable forcing the PWM out and complement out.
Definition: focHALInterface.h:500
void HAL_SetSystemFrequency(const int32_t systemPeriod)
Set System timer frequency.
Definition: focHALInterface.c:886
Gate Driver Module.
#define FOC_PWMA0_INST
PWM instance.
Definition: focPeriphInit.h:136
HAL interface for FOC Module.
__STATIC_INLINE void HAL_PWMForceLow(DL_TIMER_CC_INDEX CCIdx)
Force the PWM out to low and complement out to high.
Definition: focHALInterface.h:390
void HAL_setIPDPulseConfig(VOLTAGE_VECTOR vector, uint8_t CompVal, CURRENT_OFFSET_T *pOffset)
Set IPD Pulse configuration.
Definition: focHALInterface.c:1371
void HAL_clearFaultStatus(void)
Clears the fault status in pwm.
Definition: focHALInterface.c:949
void HAL_SetPhaseCurrentChannels(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs)
Set Phase current channels.
Definition: focHALInterface.c:118
Definition: focHALInterface.h:144
__STATIC_INLINE void HAL_PWMAllForceLow()
Forcing low All PWM out and complement out.
Definition: focHALInterface.h:419
ADC_SAMPLING_RATIO_TYPES
ADC sampling ratio types.
Definition: measure.h:146
Motor Control Library Module.
void HAL_ReadMotorInputs(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs)
Read Motor inputs.
Definition: focHALInterface.c:91
Definition: focHALInterface.h:152
uint16_t HAL_IPDGetTime(void)
Returns the time captured.
Definition: focHALInterface.c:1394
void HAL_UpdateDuty(const MC_ABC_T *pABC, const int32_t FullDuty, MC_SECTOR_TYPES voltageSector, int32_t minDelta, int32_t blankingTime)
Set PWM dutycycles.
Definition: focHALInterface.c:741
Library of IQMath operations.
void HAL_ReadCurrents(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs)
Read phase currents.
Definition: focHALInterface.c:178
__STATIC_INLINE void HAL_enableTriggerFault(GPTIMER_Regs *gptimer)
Enable trigger fault for a timer.
Definition: focHALInterface.h:510
void HAL_IPDCOMPDACSetZero(void)
Set Comparator DAC to zero.
ABC 3 phase structure.
Definition: mcLib.h:128
__STATIC_INLINE void HAL_ADCEnConv(ADC12_Regs *adc12)
Disable forcing the PWM out and complement out.
Definition: focHALInterface.h:480
Definition: focHALInterface.h:154
Application Interface.
HAL interface for FOC Module.
MC_SECTOR_TYPES
Sector types.
Definition: mcLib.h:183
void HAL_exitIPDMode()
Sets the peripheral configuration when IPD completes.
Definition: focHALInterface.c:821
uint32_t HAL_getRawFaultStatus(void)
Gets the fault status.
Definition: focHALInterface.c:943
void HAL_ClearNFault(void)
Sets Nfault pin low.
Definition: focHALInterface.c:927
__STATIC_INLINE void HAL_TimerOverRideCCPOut(GPTIMER_Regs *gptimer, DL_TIMER_FORCE_OUT out, DL_TIMER_FORCE_CMPL_OUT outComp, DL_TIMER_CC_INDEX ccIndex)
Overrides the timer CCP output.
Definition: focHALInterface.h:355
__STATIC_INLINE void HAL_FGToggle(void)
Toggle the GPIO to high and low for every sector change.
Definition: focHALInterface.h:370
__STATIC_INLINE void HAL_ADCDisConv(ADC12_Regs *adc12)
Disable forcing the PWM out and complement out.
Definition: focHALInterface.h:471
void HAL_SetNFault(void)
Sets Nfault pin high.
Definition: focHALInterface.c:932
_Bool HAL_getBrakePinStatus(void)
Get the status of the brake pin.
Definition: focHALInterface.c:1009
void HAL_resetPOR(void)
Triggers a POR reset.
Definition: focHALInterface.c:998
void HAL_EnablePWM(void)
Enable PWMs.
Definition: focHALInterface.c:314
uint16_t HAL_Is_SingleShunt(void)
Returns Shunt Config.
Definition: focHALInterface.c:1411
void HAL_delayMicroSeconds(uint32_t num_us)
Blocks for the specified delay time.
Definition: focHALInterface.c:984
uint32_t HAL_getRawHVdieFaultStatus(void)
Gets the latched fault status.
Definition: focHALInterface.c:937
__STATIC_INLINE void HAL_PWMAllForceDisable()
Disable forcing All PWM out and complement out.
Definition: focHALInterface.h:409
void HAL_setGateDriveOffsetCalib(void)
Starts gate driver offset calibration.
Definition: focHALInterface.c:954
__STATIC_INLINE void HAL_setCaptureCompareValue(GPTIMER_Regs *gptimer, uint32_t value, DL_TIMER_CC_INDEX ccIndex)
Set the Capture Compare Value for Timer.
Definition: focHALInterface.h:530
void HAL_IPDEnableISR(void)
Enables the IPD capture timer.
Definition: focHALInterface.c:1380
Definition: focHALInterface.h:146
void HAL_SetADCSamplingFrequency(const ADC_SAMPLING_RATIO_TYPES samplingRatio)
Set ADC sampling frequency.
Definition: focHALInterface.c:874
Definition: focHALInterface.h:156
void HAL_setADCIdxChannel(ADC12_Regs *adc12, DL_ADC12_MEM_IDX idx, uint32_t chansel)
Set ADC channel to index.
Definition: focHALInterface.c:133
void HAL_DisablePWM(void)
Disable PWMs and all outputs are forced low.
Definition: focHALInterface.c:332
void HAL_SetPWMFrequency(const int32_t pwmPeriod, const int32_t propagationDelay)
Set PWM Frequency.
Definition: focHALInterface.c:755
Definition: focHALInterface.h:148
__STATIC_INLINE void HAL_ADCEnWCOMP(ADC12_Regs *adc12, DL_ADC12_MEM_IDX idx)
Disable forcing the PWM out and complement out.
Definition: focHALInterface.h:490
IQ Numeric Module.
__STATIC_INLINE void HAL_PWMForceHigh(DL_TIMER_CC_INDEX CCIdx)
Force the PWM out to high and complement out to low.
Definition: focHALInterface.h:380
void HAL_SetPhaseVoltageChannels(HAL_MEASURE_MOTOR_INPUTS_T *pMotorInputs)
Set Phase voltage channels in ADC.
Definition: focHALInterface.c:140
_Bool HAL_getDirPinStatus(void)
Get the status of the Direction pin.
Definition: focHALInterface.c:1003
__STATIC_INLINE void HAL_PWMForceDisable(DL_TIMER_CC_INDEX CCIdx)
Disable forcing the PWM out and complement out.
Definition: focHALInterface.h:400
void HAL_resetGateDriveOffsetCalib(void)
Stops gate driver offset calibration.
Definition: focHALInterface.c:959
© Copyright 1995-2025, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale