|
| 1 | +/******************************************************************************* |
| 2 | + Motor Control Library Interface Header File |
| 3 | +
|
| 4 | + File Name: |
| 5 | + motor_control.h |
| 6 | +
|
| 7 | + Summary: |
| 8 | + This header file lists all the interfaces used by the Motor Control library. |
| 9 | +
|
| 10 | + Description: |
| 11 | + This header file lists the type defines for structures used by the Motor |
| 12 | + Control library. Library function definitions are also listed along with |
| 13 | + information regarding the arguments of each library function. This header file |
| 14 | + also includes another header file that hosts inline definitions of certain |
| 15 | + library functions. |
| 16 | +*******************************************************************************/ |
| 17 | + |
| 18 | +// DOM-IGNORE-BEGIN |
| 19 | +/* ********************************************************************* |
| 20 | + * (c) 2017 Microchip Technology Inc. and its subsidiaries. You may use |
| 21 | + * this software and any derivatives exclusively with Microchip products. |
| 22 | + * |
| 23 | + * This software and any accompanying information is for suggestion only. |
| 24 | + * It does not modify Microchip's standard warranty for its products. |
| 25 | + * You agree that you are solely responsible for testing the software and |
| 26 | + * determining its suitability. Microchip has no obligation to modify, |
| 27 | + * test, certify, or support the software. |
| 28 | + |
| 29 | + * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, |
| 30 | + * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, |
| 31 | + * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, |
| 32 | + * AND FITNESS FOR A PARTICULAR PURPOSE, OR ITS INTERACTION WITH |
| 33 | + * MICROCHIP PRODUCTS, COMBINATION WITH ANY OTHER PRODUCTS, OR USE IN ANY |
| 34 | + * APPLICATION. |
| 35 | + |
| 36 | + * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, |
| 37 | + * PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF |
| 38 | + * ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF |
| 39 | + * MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE |
| 40 | + * FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL |
| 41 | + * LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT |
| 42 | + * EXCEED THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO |
| 43 | + * MICROCHIP FOR THIS SOFTWARE. |
| 44 | + |
| 45 | + * MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF |
| 46 | + * THESE TERMS. |
| 47 | + * |
| 48 | + * *****************************************************************************/ |
| 49 | +/******************************************************************************* |
| 50 | +Note: |
| 51 | +* Some parts of this header file are protected by #ifdef __XC16__. These protections |
| 52 | + are provided to accommodate non-XC16 compilers to work with this header file. |
| 53 | + Similarly, sections of the header file related to the MATLAB-based compiler are |
| 54 | + protected by #ifdef __MATLAB_MEX__ protections. |
| 55 | +* Some of the function declarations have a MC_ATTRB prefix. This prefix has been |
| 56 | + provided as a placeholder for adding attributes for supporting future versions |
| 57 | + of the compiler. |
| 58 | +*******************************************************************************/ |
| 59 | +// DOM-IGNORE-END |
| 60 | + |
| 61 | +#ifndef _MOTOR_CONTROL_H_ // Guards against multiple inclusion |
| 62 | +#define _MOTOR_CONTROL_H_ |
| 63 | + |
| 64 | +// ***************************************************************************** |
| 65 | +// ***************************************************************************** |
| 66 | +// Section: Included Files |
| 67 | +// ***************************************************************************** |
| 68 | +// ***************************************************************************** |
| 69 | + |
| 70 | +#include <stdint.h> |
| 71 | +#ifdef __XC16__ // See comments at the top of this header file |
| 72 | +#include <xc.h> |
| 73 | +#endif // __XC16__ |
| 74 | + |
| 75 | +#ifdef __cplusplus // Provide C++ Compatability |
| 76 | + extern "C" { |
| 77 | +#endif |
| 78 | + |
| 79 | +#ifdef __MATLAB_MEX__ // See comments at the top of this header file |
| 80 | +#define inline |
| 81 | +#endif // __MATLAB_MEX |
| 82 | + |
| 83 | + |
| 84 | +#include "motor_control_declarations.h" |
| 85 | +#include "motor_control_inline_declarations.h" |
| 86 | + |
| 87 | + |
| 88 | +#ifdef __XC16__ // See comments at the top of this header file |
| 89 | +#include "./motor_control_inline_dspic.h" |
| 90 | +#endif // __XC16__ |
| 91 | + |
| 92 | +#ifdef __cplusplus // Provide C++ Compatibility |
| 93 | + } |
| 94 | +#endif |
| 95 | +#endif // _MOTOR_CONTROL_H |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | + |
0 commit comments