Workshop example
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
sensors/LIS3MDL/magneto.h@35:42b3fba640b1, 2019-05-21 (annotated)
- Committer:
- JimCarver
- Date:
- Tue May 21 21:16:24 2019 +0000
- Revision:
- 35:42b3fba640b1
- Parent:
- 18:a15bfe7aaebd
Simple version for workshop
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
screamer | 18:a15bfe7aaebd | 1 | /** |
screamer | 18:a15bfe7aaebd | 2 | ****************************************************************************** |
screamer | 18:a15bfe7aaebd | 3 | * @file magneto.h |
screamer | 18:a15bfe7aaebd | 4 | * @author MEMS Application Team |
screamer | 18:a15bfe7aaebd | 5 | * @version V1.2.0 |
screamer | 18:a15bfe7aaebd | 6 | * @date 28-January-2015 |
screamer | 18:a15bfe7aaebd | 7 | * @brief This header file contains the functions prototypes for the |
screamer | 18:a15bfe7aaebd | 8 | * magneto driver. |
screamer | 18:a15bfe7aaebd | 9 | ****************************************************************************** |
screamer | 18:a15bfe7aaebd | 10 | * @attention |
screamer | 18:a15bfe7aaebd | 11 | * |
screamer | 18:a15bfe7aaebd | 12 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
screamer | 18:a15bfe7aaebd | 13 | * |
screamer | 18:a15bfe7aaebd | 14 | * Redistribution and use in source and binary forms, with or without modification, |
screamer | 18:a15bfe7aaebd | 15 | * are permitted provided that the following conditions are met: |
screamer | 18:a15bfe7aaebd | 16 | * 1. Redistributions of source code must retain the above copyright notice, |
screamer | 18:a15bfe7aaebd | 17 | * this list of conditions and the following disclaimer. |
screamer | 18:a15bfe7aaebd | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
screamer | 18:a15bfe7aaebd | 19 | * this list of conditions and the following disclaimer in the documentation |
screamer | 18:a15bfe7aaebd | 20 | * and/or other materials provided with the distribution. |
screamer | 18:a15bfe7aaebd | 21 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
screamer | 18:a15bfe7aaebd | 22 | * may be used to endorse or promote products derived from this software |
screamer | 18:a15bfe7aaebd | 23 | * without specific prior written permission. |
screamer | 18:a15bfe7aaebd | 24 | * |
screamer | 18:a15bfe7aaebd | 25 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
screamer | 18:a15bfe7aaebd | 26 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
screamer | 18:a15bfe7aaebd | 27 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
screamer | 18:a15bfe7aaebd | 28 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
screamer | 18:a15bfe7aaebd | 29 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
screamer | 18:a15bfe7aaebd | 30 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
screamer | 18:a15bfe7aaebd | 31 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
screamer | 18:a15bfe7aaebd | 32 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
screamer | 18:a15bfe7aaebd | 33 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
screamer | 18:a15bfe7aaebd | 34 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
screamer | 18:a15bfe7aaebd | 35 | * |
screamer | 18:a15bfe7aaebd | 36 | ****************************************************************************** |
screamer | 18:a15bfe7aaebd | 37 | */ |
screamer | 18:a15bfe7aaebd | 38 | |
screamer | 18:a15bfe7aaebd | 39 | |
screamer | 18:a15bfe7aaebd | 40 | /* Define to prevent recursive inclusion -------------------------------------*/ |
screamer | 18:a15bfe7aaebd | 41 | #ifndef __MAGNETO_H |
screamer | 18:a15bfe7aaebd | 42 | #define __MAGNETO_H |
screamer | 18:a15bfe7aaebd | 43 | |
screamer | 18:a15bfe7aaebd | 44 | #ifdef __cplusplus |
screamer | 18:a15bfe7aaebd | 45 | extern "C" { |
screamer | 18:a15bfe7aaebd | 46 | #endif |
screamer | 18:a15bfe7aaebd | 47 | |
screamer | 18:a15bfe7aaebd | 48 | /* Includes ------------------------------------------------------------------*/ |
screamer | 18:a15bfe7aaebd | 49 | #include <stdint.h> |
screamer | 18:a15bfe7aaebd | 50 | |
screamer | 18:a15bfe7aaebd | 51 | /** @addtogroup BSP |
screamer | 18:a15bfe7aaebd | 52 | * @{ |
screamer | 18:a15bfe7aaebd | 53 | */ |
screamer | 18:a15bfe7aaebd | 54 | |
screamer | 18:a15bfe7aaebd | 55 | /** @addtogroup Components |
screamer | 18:a15bfe7aaebd | 56 | * @{ |
screamer | 18:a15bfe7aaebd | 57 | */ |
screamer | 18:a15bfe7aaebd | 58 | |
screamer | 18:a15bfe7aaebd | 59 | /** @addtogroup MAGNETO |
screamer | 18:a15bfe7aaebd | 60 | * @{ |
screamer | 18:a15bfe7aaebd | 61 | */ |
screamer | 18:a15bfe7aaebd | 62 | |
screamer | 18:a15bfe7aaebd | 63 | /** @defgroup MAGNETO_Exported_Types |
screamer | 18:a15bfe7aaebd | 64 | * @{ |
screamer | 18:a15bfe7aaebd | 65 | */ |
screamer | 18:a15bfe7aaebd | 66 | |
screamer | 18:a15bfe7aaebd | 67 | /** |
screamer | 18:a15bfe7aaebd | 68 | * @brief MAGNETO init structure definition |
screamer | 18:a15bfe7aaebd | 69 | */ |
screamer | 18:a15bfe7aaebd | 70 | typedef struct |
screamer | 18:a15bfe7aaebd | 71 | { |
screamer | 18:a15bfe7aaebd | 72 | uint8_t M_OutputDataRate; |
screamer | 18:a15bfe7aaebd | 73 | uint8_t M_OperatingMode; |
screamer | 18:a15bfe7aaebd | 74 | uint8_t M_FullScale; |
screamer | 18:a15bfe7aaebd | 75 | uint8_t M_XYOperativeMode; |
screamer | 18:a15bfe7aaebd | 76 | } MAGNETO_InitTypeDef; |
screamer | 18:a15bfe7aaebd | 77 | |
screamer | 18:a15bfe7aaebd | 78 | /** |
screamer | 18:a15bfe7aaebd | 79 | * @brief MAGNETO status enumerator definition |
screamer | 18:a15bfe7aaebd | 80 | */ |
screamer | 18:a15bfe7aaebd | 81 | typedef enum |
screamer | 18:a15bfe7aaebd | 82 | { |
screamer | 18:a15bfe7aaebd | 83 | MAGNETO_OK = 0, |
screamer | 18:a15bfe7aaebd | 84 | MAGNETO_ERROR = 1, |
screamer | 18:a15bfe7aaebd | 85 | MAGNETO_TIMEOUT = 2, |
screamer | 18:a15bfe7aaebd | 86 | MAGNETO_NOT_IMPLEMENTED = 3 |
screamer | 18:a15bfe7aaebd | 87 | } MAGNETO_StatusTypeDef; |
screamer | 18:a15bfe7aaebd | 88 | |
screamer | 18:a15bfe7aaebd | 89 | /** |
screamer | 18:a15bfe7aaebd | 90 | * @brief MAGNETO component id enumerator definition |
screamer | 18:a15bfe7aaebd | 91 | */ |
screamer | 18:a15bfe7aaebd | 92 | typedef enum |
screamer | 18:a15bfe7aaebd | 93 | { |
screamer | 18:a15bfe7aaebd | 94 | MAGNETO_NONE_COMPONENT = 0, |
screamer | 18:a15bfe7aaebd | 95 | MAGNETO_LIS3MDL_COMPONENT = 1 |
screamer | 18:a15bfe7aaebd | 96 | } MAGNETO_ComponentTypeDef; |
screamer | 18:a15bfe7aaebd | 97 | |
screamer | 18:a15bfe7aaebd | 98 | /** |
screamer | 18:a15bfe7aaebd | 99 | * @brief MAGNETO driver extended structure definition |
screamer | 18:a15bfe7aaebd | 100 | */ |
screamer | 18:a15bfe7aaebd | 101 | typedef struct |
screamer | 18:a15bfe7aaebd | 102 | { |
screamer | 18:a15bfe7aaebd | 103 | MAGNETO_ComponentTypeDef |
screamer | 18:a15bfe7aaebd | 104 | id; /* This id must be unique for each component belonging to this class that wants to extend common class */ |
screamer | 18:a15bfe7aaebd | 105 | void *pData; /* This pointer is specific for each component */ |
screamer | 18:a15bfe7aaebd | 106 | } MAGNETO_DrvExtTypeDef; |
screamer | 18:a15bfe7aaebd | 107 | |
screamer | 18:a15bfe7aaebd | 108 | /** |
screamer | 18:a15bfe7aaebd | 109 | * @brief MAGNETO driver structure definition |
screamer | 18:a15bfe7aaebd | 110 | */ |
screamer | 18:a15bfe7aaebd | 111 | typedef struct |
screamer | 18:a15bfe7aaebd | 112 | { |
screamer | 18:a15bfe7aaebd | 113 | MAGNETO_StatusTypeDef (*Init)(MAGNETO_InitTypeDef *); |
screamer | 18:a15bfe7aaebd | 114 | MAGNETO_StatusTypeDef (*Read_M_ID)(uint8_t *); |
screamer | 18:a15bfe7aaebd | 115 | MAGNETO_StatusTypeDef (*Get_M_Axes)(int32_t *); |
screamer | 18:a15bfe7aaebd | 116 | MAGNETO_StatusTypeDef (*Get_M_AxesRaw)(int16_t *); |
screamer | 18:a15bfe7aaebd | 117 | MAGNETO_DrvExtTypeDef *extData; |
screamer | 18:a15bfe7aaebd | 118 | } MAGNETO_DrvTypeDef; |
screamer | 18:a15bfe7aaebd | 119 | |
screamer | 18:a15bfe7aaebd | 120 | /** |
screamer | 18:a15bfe7aaebd | 121 | * @} |
screamer | 18:a15bfe7aaebd | 122 | */ |
screamer | 18:a15bfe7aaebd | 123 | |
screamer | 18:a15bfe7aaebd | 124 | /** |
screamer | 18:a15bfe7aaebd | 125 | * @} |
screamer | 18:a15bfe7aaebd | 126 | */ |
screamer | 18:a15bfe7aaebd | 127 | |
screamer | 18:a15bfe7aaebd | 128 | /** |
screamer | 18:a15bfe7aaebd | 129 | * @} |
screamer | 18:a15bfe7aaebd | 130 | */ |
screamer | 18:a15bfe7aaebd | 131 | |
screamer | 18:a15bfe7aaebd | 132 | /** |
screamer | 18:a15bfe7aaebd | 133 | * @} |
screamer | 18:a15bfe7aaebd | 134 | */ |
screamer | 18:a15bfe7aaebd | 135 | |
screamer | 18:a15bfe7aaebd | 136 | #ifdef __cplusplus |
screamer | 18:a15bfe7aaebd | 137 | } |
screamer | 18:a15bfe7aaebd | 138 | #endif |
screamer | 18:a15bfe7aaebd | 139 | |
screamer | 18:a15bfe7aaebd | 140 | #endif /* __MAGNETO_H */ |
screamer | 18:a15bfe7aaebd | 141 | |
screamer | 18:a15bfe7aaebd | 142 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |