Sync inav to Gitea

2026-08-03 16:37:40 +08:00
commit dac37fd077
14095 changed files with 5603119 additions and 0 deletions
@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="pandoc" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <title>Release Notes for M24LR64 Component Driver</title>
+  <style type="text/css">
+      code{white-space: pre-wrap;}
+      span.smallcaps{font-variant: small-caps;}
+      span.underline{text-decoration: underline;}
+      div.column{display: inline-block; vertical-align: top; width: 50%;}
+  </style>
+  <link rel="stylesheet" href="_htmresc/mini-st.css" />
+  <!--[if lt IE 9]>
+    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+  <![endif]-->
+</head>
+<body>
+<div class="row">
+<div class="col-sm-12 col-lg-4">
+<div class="card fluid">
+<div class="sectione dark">
+<center>
+<h1 id="release-notes-for-m24lr64-component-driver"><strong>Release Notes for M24LR64 Component Driver</strong></h1>
+<p>Copyright © 2019 STMicroelectronics<br />
+</p>
+<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo.png" alt="ST logo" /></a>
+</center>
+</div>
+</div>
+<h1 id="license">License</h1>
+This software component is licensed by ST under BSD 3-Clause license, the “License”; You may not use this component except in compliance with the License. You may obtain a copy of the License at:
+<center>
+<a href="https://opensource.org/licenses/BSD-3-Clause">https://opensource.org/licenses/BSD-3-Clause</a>
+</center>
+<h1 id="purpose">Purpose</h1>
+<p>This driver provides a set of EEPROM functions offered by M24LR64 component</p>
+</div>
+<div class="col-sm-12 col-lg-8">
+<h1 id="update-history">Update History</h1>
+<div class="collapse">
+<input type="checkbox" id="collapse-section1" checked aria-hidden="true"> <label for="collapse-section1" aria-hidden="true"><strong>V1.0.0 / 30-October-2019</strong></label>
+<div>
+<h2 id="main-changes">Main Changes</h2>
+<ul>
+<li>First official release of <strong>M24LR64</strong> EEPROM Component drivers in line with STM32Cube BSP drivers development guidelines (UM2298)</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<footer class="sticky">
+For complete documentation on <mark>STM32 Microcontrollers</mark> , visit: <span style="font-color: blue;"><a href="http://www.st.com/STM32">www.st.com</a></span>
+</footer>
+</body>
+</html>
@@ -0,0 +1,55 @@
+---
+pagetitle: Release Notes for M24LR64 Component Driver
+lang: en
+---
+
+::: {.row}
+::: {.col-sm-12 .col-lg-4}
+
+::: {.card .fluid}
+::: {.sectione .dark}
+<center>
+# **Release Notes for M24LR64 Component Driver**
+Copyright &copy; 2019 STMicroelectronics\
+    
+[![ST logo](_htmresc/st_logo.png)](https://www.st.com){.logo}
+</center>
+:::
+:::
+
+# License
+
+This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this component except in 
+compliance with the License. You may obtain a copy of the License at:
+<center>
+[https://opensource.org/licenses/BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)
+</center>
+
+# Purpose
+
+This driver provides a set of EEPROM functions offered by M24LR64 component
+
+:::
+
+::: {.col-sm-12 .col-lg-8}
+# Update History
+
+::: {.collapse}
+<input type="checkbox" id="collapse-section1" checked aria-hidden="true">
+<label for="collapse-section1" aria-hidden="true">__V1.0.0 / 30-October-2019__</label>
+<div>			
+
+## Main Changes
+
+-	First official release of **M24LR64** EEPROM Component drivers in line with STM32Cube BSP drivers development guidelines (UM2298)
+
+</div>
+:::
+
+:::
+:::
+
+<footer class="sticky">
+For complete documentation on <mark>STM32 Microcontrollers</mark> ,
+visit: [[www.st.com](http://www.st.com/STM32)]{style="font-color: blue;"}
+</footer>
@@ -0,0 +1,231 @@
+/**
+  ******************************************************************************
+  * @file    m24lr64.c
+  * @author  MCD Application Team
+  * @brief   This file provides a set of functions to interface with the M24LR64
+  *          device.
+  ******************************************************************************
+  * @attention
+  *
+  * <h2><center>&copy; Copyright (c) 2019 STMicroelectronics.
+  * All rights reserved.</center></h2>
+  *
+  * This software component is licensed by ST under BSD 3-Clause license,
+  * the "License"; You may not use this file except in compliance with the
+  * License. You may obtain a copy of the License at:
+  *                        opensource.org/licenses/BSD-3-Clause
+  *
+  ******************************************************************************
+  */
+
+/* Includes ------------------------------------------------------------------*/
+#include "m24lr64.h"
+
+/** @addtogroup BSP
+  * @{
+  */
+  
+/** @addtogroup Components
+  * @{
+  */ 
+
+/** @defgroup M24LR64 M24LR64
+  * @{
+  */
+
+/** @defgroup M24LR64_Private_Types M24LR64 Private Types
+  * @{
+  */
+M24LR64_EEPROM_Drv_t   M24LR64_EEPROM_Driver = 
+{
+  M24LR64_Init,
+  M24LR64_DeInit,
+  M24LR64_Write,  
+  M24LR64_Read,
+  M24LR64_IsReady
+};    
+/**
+  * @}
+  */    
+/** @defgroup M24LR64_Private_FunctionPrototypes M24LR64 Private Function Prototypes
+  * @{
+  */
+static int32_t M24LR64_ReadWrap(void *handle, uint16_t Addr, uint8_t* Data, uint16_t Length);
+static int32_t M24LR64_WriteWrap(void *handle, uint16_t Addr, uint8_t* Data, uint16_t Length);
+static int32_t M24LR64_IsReadyWrap(void *handle, uint32_t Trials);
+
+/**
+  * @}
+  */ 
+
+/** @defgroup M24LR64_Private_Functions M24LR64 Private Functions
+  * @{
+  */
+/**
+  * @brief  Function
+  * @param  Component object pointer
+  * @retval Component status
+  */
+int32_t M24LR64_RegisterBusIO (M24LR64_Object_t *pObj, M24LR64_IO_t *pIO)
+{
+  int32_t ret;
+    
+    if(pObj == NULL)
+    {
+      ret = M24LR64_ERROR;
+    }
+    else
+    {
+      pObj->IO.Init      = pIO->Init;
+      pObj->IO.DeInit    = pIO->DeInit;
+      pObj->IO.Address   = pIO->Address;
+      pObj->IO.Write     = pIO->Write;
+      pObj->IO.Read      = pIO->Read;
+      pObj->IO.IsReady   = pIO->IsReady;
+      
+      pObj->Ctx.Read     = M24LR64_ReadWrap;
+      pObj->Ctx.Write    = M24LR64_WriteWrap;
+      pObj->Ctx.IsReady  = M24LR64_IsReadyWrap;
+      pObj->Ctx.handle   = pObj;
+      
+      if(pObj->IO.Init != NULL)
+      {
+        ret = pObj->IO.Init();
+      }
+      else
+      {
+        ret = M24LR64_ERROR;
+      }
+    }
+  
+  return ret;
+}
+
+ 
+/**
+  * @brief  Initializes the M24LR64 EEPROM component.
+  * @param  pObj  M24LR64 object
+  * @retval Component status
+  */
+int32_t M24LR64_Init(M24LR64_Object_t *pObj)
+{
+  if(pObj->IsInitialized != 1U)
+  {
+    pObj->IO.Init();
+    pObj->IsInitialized = 0;
+  }
+  return M24LR64_OK;
+} 
+
+/**
+  * @brief  DeInitializes the M24LR64 EEPROM component.
+  * @param  pObj  M24LR64 object
+  * @retval Component status
+  */
+int32_t M24LR64_DeInit(M24LR64_Object_t *pObj)
+{
+  if(pObj->IsInitialized != 0U)
+  {
+    pObj->IsInitialized = 1;
+  }
+  return M24LR64_OK;
+}
+
+/**
+  * @brief  DeInitializes the M24LR64 EEPROM component.
+  * @param  pObj  M24LR64 object
+  * @retval Component status
+  */
+int32_t M24LR64_Write(M24LR64_Object_t *pObj, uint16_t Addr, uint8_t *Data, uint16_t Length)
+{
+  return pObj->Ctx.Write(pObj->Ctx.handle, Addr, Data, Length);
+}
+
+/**
+  * @brief  DeInitializes the M24LR64 EEPROM component.
+  * @param  pObj  M24LR64 object
+  * @retval Component status
+  */
+int32_t M24LR64_Read(M24LR64_Object_t *pObj, uint16_t Addr, uint8_t *Data, uint16_t Length)
+{
+  return pObj->Ctx.Read(pObj->Ctx.handle, Addr, Data, Length);
+}
+
+/**
+  * @brief  Check if the M24LR64 EEPROM component is ready.
+  * @param  pObj  M24LR64 object
+  * @param  Trials  The number of trials before returning a timeout error
+  * @retval Component status
+  */
+int32_t M24LR64_IsReady(M24LR64_Object_t *pObj, uint32_t Trials)
+{
+  return pObj->Ctx.IsReady(pObj->Ctx.handle, Trials);
+}
+/**
+  * @}
+  */ 
+
+/** @addtogroup M24LR64_Private_FunctionPrototypes
+  * @{
+  */
+/**
+  * @brief  Wrap component ReadReg to Bus Read function
+  * @param  handle Component object handle
+  * @param  Addr   The target address to read
+  * @param  pData  The target register value to be written
+  * @param  Length Buffer size to be written
+  * @retval Component status
+  */
+static int32_t M24LR64_ReadWrap(void *handle, uint16_t Addr, uint8_t* pData, uint16_t Length)
+{
+  M24LR64_Object_t *pObj = (M24LR64_Object_t *)handle;
+
+  return pObj->IO.Read(pObj->IO.Address, Addr, pData, Length);
+}
+
+/**
+  * @brief  Wrap component WriteReg to Bus Write function
+  * @param  handle  Component object handle
+  * @param  Addr    The target address to write
+  * @param  pData   The target register value to be written
+  * @param  Length  Buffer size to be written
+  * @retval Component status
+  */
+static int32_t M24LR64_WriteWrap(void *handle, uint16_t Addr, uint8_t* pData, uint16_t Length)
+{
+  M24LR64_Object_t *pObj = (M24LR64_Object_t *)handle;
+
+  return pObj->IO.Write(pObj->IO.Address, Addr, pData, Length);
+}
+
+/**
+  * @brief  Wrap component IsReady to Bus IsReady function
+  * @param  handle  Component object handle
+  * @param  Trials  The number of trials before returning a timeout error
+  * @retval Component status
+  */
+static int32_t M24LR64_IsReadyWrap(void *handle, uint32_t Trials)
+{
+  M24LR64_Object_t *pObj = (M24LR64_Object_t *)handle;
+  
+  return pObj->IO.IsReady(pObj->IO.Address, Trials);
+}
+
+/**
+  * @}
+  */
+
+
+/**
+  * @}
+  */
+
+/**
+  * @}
+  */
+
+/**
+  * @}
+  */
+
+/******************* (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
@@ -0,0 +1,146 @@
+/**
+  ******************************************************************************
+  * @file    m24lr64.h
+  * @author  MCD Application Team
+  * @brief   This file is the header of m24lr64.c
+  ******************************************************************************
+  * @attention
+  *
+  * <h2><center>&copy; Copyright (c) 2019 STMicroelectronics.
+  * All rights reserved.</center></h2>
+  *
+  * This software component is licensed by ST under BSD 3-Clause license,
+  * the "License"; You may not use this file except in compliance with the
+  * License. You may obtain a copy of the License at:
+  *                        opensource.org/licenses/BSD-3-Clause
+  *
+  ******************************************************************************
+  */
+
+/* Define to prevent recursive inclusion -------------------------------------*/
+#ifndef M24LR64_H
+#define M24LR64_H
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+/* Includes ------------------------------------------------------------------*/  
+#include <stdint.h>
+#include <stddef.h>
+   
+/** @addtogroup BSP
+  * @{
+  */
+
+/** @addtogroup Component
+  * @{
+  */
+
+/** @addtogroup M24LR64 
+  * @{
+  */
+  
+/** @defgroup M24LR64_Exported_Types   M24LR64 Exported Types
+  * @{
+  */
+typedef int32_t (*M24LR64_Init_Func)    (void);
+typedef int32_t (*M24LR64_DeInit_Func)  (void);
+typedef int32_t (*M24LR64_GetTick_Func) (void);
+typedef int32_t (*M24LR64_Delay_Func)   (uint32_t);
+typedef int32_t (*M24LR64_WriteReg_Func)   (uint16_t, uint16_t, uint8_t*, uint16_t);
+typedef int32_t (*M24LR64_ReadReg_Func)    (uint16_t, uint16_t, uint8_t*, uint16_t);
+typedef int32_t (*M24LR64_IsDeviceReady_Func) (uint16_t, uint32_t);
+
+
+typedef int32_t (*M24LR64_Write_Func)(void *, uint16_t, uint8_t*, uint16_t);
+typedef int32_t (*M24LR64_Read_Func) (void *, uint16_t, uint8_t*, uint16_t);
+typedef int32_t (*M24LR64_IsReady_Func) (void *, uint32_t);
+
+typedef struct
+{
+  M24LR64_Write_Func     Write;
+  M24LR64_Read_Func      Read;
+  M24LR64_IsReady_Func   IsReady;
+  void                   *handle;
+} M24LR64_Ctx_t;
+
+typedef struct
+{
+  M24LR64_Init_Func           Init;
+  M24LR64_DeInit_Func         DeInit;
+  uint16_t                    Address;  
+  M24LR64_WriteReg_Func       Write;
+  M24LR64_ReadReg_Func        Read;
+  M24LR64_IsDeviceReady_Func  IsReady;
+  M24LR64_GetTick_Func        GetTick;
+} M24LR64_IO_t;
+
+typedef struct
+{
+  M24LR64_IO_t         IO;
+  M24LR64_Ctx_t        Ctx;   
+  uint8_t              IsInitialized;
+} M24LR64_Object_t;
+
+typedef struct
+{
+  int32_t  (*Init     )(M24LR64_Object_t*);
+  int32_t  (*DeInit   )(M24LR64_Object_t*);   
+  int32_t  (*Write    )(M24LR64_Object_t*, uint16_t, uint8_t*, uint16_t);
+  int32_t  (*Read     )(M24LR64_Object_t*, uint16_t, uint8_t*, uint16_t);
+  int32_t  (*IsReady  )(M24LR64_Object_t*, uint32_t); 
+}M24LR64_EEPROM_Drv_t;
+/**
+  * @}
+  */
+
+/** @defgroup M24LR64_Exported_Constants   M24LR64 Exported Constants
+  * @{
+  */
+#define M24LR64_OK      0
+#define M24LR64_ERROR  -1
+
+/**
+  * @}
+  */
+
+/** @defgroup M24LR64_Exported_FunctionsPrototypes   M24LR64 Exported FunctionsPrototypes
+  * @{
+  */  
+/*  public function  --------------------------------------------------------------------------*/
+int32_t M24LR64_RegisterBusIO (M24LR64_Object_t *pObj, M24LR64_IO_t *pIO);  
+int32_t M24LR64_Init(M24LR64_Object_t *pObj);
+int32_t M24LR64_DeInit(M24LR64_Object_t *pObj);
+int32_t M24LR64_Write(M24LR64_Object_t *pObj, uint16_t Addr, uint8_t *Data, uint16_t Length);
+int32_t M24LR64_Read(M24LR64_Object_t *pObj, uint16_t Addr, uint8_t *Data, uint16_t Length);
+int32_t M24LR64_IsReady(M24LR64_Object_t *pObj, uint32_t Trials);
+
+
+extern M24LR64_EEPROM_Drv_t   M24LR64_EEPROM_Driver;
+/**
+  * @}
+  */ 
+
+/**
+  * @}
+  */
+
+/**
+  * @}
+  */
+
+/**
+  * @}
+  */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* M24LR64_H */
+
+
+
+
+/******************* (C) COPYRIGHT STMicroelectronics *****END OF FILE****/