AN1905 ST Microelectronics, Inc., AN1905 Datasheet - Page 25

• Manufacturer Part Number: AN1905
• Description: St7mc Three-phase BLDC Motor Control Software Library
• Manufacturer: ST Microelectronics, Inc.

4 MODULES PRESENTATION, LIBRARY ROUTINES
4.1 LIBRARY REFERENCES
Functions are described in the format given below:
Synopsis
Description
Input
Returns
Caution
Warning
Functions called
Code example
Some of these sections may not be included if not applicable (no parameters, obvious use,
etc.).
4.2 MTC SOFTWARE LAYER
The software related to the MTC peripheral is part of a module which is call ‘mtc.c’. This
module refers to all the routines needed to initiate and run the peripheral properly. The dedi-
cated MTC hardware registers declaration are also grouped into a module named ‘mtc_hr.c’.
This module provides:
- Basic setup
- Control routines
- Related interrupt handling routines
- Speed acquisition for closed loop operation
Routine prototypes can be found in the ‘mtc.h’ header file.
ST7MC THREE-PHASE BLDC MOTOR CONTROL SOFTWARE LIBRARY
This section lists the referenced include files and prototype declarations.
The functions are specifically described with a brief explanation of how
they are executed.
This section gives the format and units.
Gives the value returned by the function, including when an input value
is out of range or an error code is returned.
Indicates the limits of the function or specific requirements that must be
taken into account before implementation.
Indicates important points that must be taken into account to prevent
hardware failures.
Used to prevent conflicts due to the simultaneous use of resources.
Indicates the proper way to use the function if there are certain prereq-
uisites (interrupt enabled, etc.).
25/77