microPython的源码解析之 ringbuf.c

MicroPython 是一种适用于微控制器和其他受限环境的 Python 编程语言的实现。它旨在提供与 Python 3 语言的紧密兼容，同时考虑到内存和计算资源的限制。MicroPython 库是这门语言的核心组成部分，提供了一系列的模块和函数，使得开发者能够在硬件上执行各种任务。
下面将通过系列文章,逐一解读microPython,以便让读者了解掌握microPython的整个核心逻辑.,以便读者可以透过这个Python的最小内核,掌握Python解析器的核心实现逻辑,学习世界上最优秀的源码设计之一.

---

microPython Python最小内核源码解析
NI-motion运动控制c语言示例代码解析
python编程示例系列 python编程示例系列二
python的Web神器Streamlit

---

这段代码实现了一个环形缓冲区的基本操作，包括读取和写入16位值以及字节序列。环形缓冲区是一种数据结构，它允许在固定大小的缓冲区中高效地存储和访问数据流。当达到缓冲区的末尾时，它会循环回到开始的位置，这就是“环形”这个名字的由来。这种数据结构在处理串行通信、音频/视频流以及其他需要缓冲的场景中非常有用。

#include <string.h>

#include "ringbuf.h"

/**
 * 从环形缓冲区中读取一个16位的值。
 * 如果成功读取，返回读取的值。
 * 如果没有足够的数据可用于读取，则返回-1。
 * 如果读取请求的大小大于缓冲区大小，则返回-2。
 * @param r 指向环形缓冲区的指针。
 * @return 读取的16位值或错误代码。
 */
int ringbuf_get16(ringbuf_t *r) {
   
    int v = ringbuf_peek16(r); // 尝试从环形缓冲区中偷看下一个16位值
    if (v == -1) {
   
        return v; // 如果偷看失败，直接返回-1
    }
    r->iget += 2; // 索引增加2，因为我们读取了两个字节
    if (r->iget >= r->size) {
   
        r->iget -= r->size; // 如果索引超出了缓冲区大小，将其循环回缓冲区的开始
    }
    return v; // 返回读取的16位值
}

/**
 * 偷看环形缓冲区中的下一个16位值，但不移动读取索引。
 * 如果成功偷看到值，返回该值。
 * 如果没有足够的数据可用于偷看，则返回-1。
 * @param r 指向环形缓冲区的指针。
 * @return 偷看到的16位值或错误代码。
 */
int ringbuf_peek16(ringbuf_t *r) {
   
    if (r->iget == r->iput) {
   
        return -1; // 如果读取和写入索引相同，说明缓冲区为空
    }
    uint32_t iget_a = r->iget + 1; // 计算下一个索引位置
    if (iget_a == r->size) {
   
        iget_a = 0; // 如果下一个索引超出了缓冲区大小，将其循环回0
    }
    if (iget_a == r->iput) {
   
        return -1; // 如果下一个索引与写入索引相同，说明数据不连续
    }
    return (r->buf[r->iget] << 8) | (r->buf[iget_a]); // 通过左移和或运算组合两个字节的值
}

/**
 * 向环形缓冲区中写入一个16位的值。
 * 如果成功写入，返回0。
 * 如果没有足够的空闲空间可用于写入，则返回-1。
 * 如果写入请求的大小大于缓冲区大小，则返回-2。
 * @param r 指向环形缓冲区的指针。
 * @param v 要写入的16位值。
 * @return 操作结果代码。
 */
int ringbuf_put16(ringbuf_t *r, uint16_t v) {
   
    uint32_t iput_a = r->iput + 1; // 计算下一个写入索引位置
    if (iput_a == r->size) {
   
        iput_a = 0; // 如果下一个索引超出了缓冲区大小，将其循环回0
    }
    if (iput_a == r->iget) {
   
        return -1; // 如果下一个索引与读取索引相同，说明缓冲区满了
    }
    uint32_t iput_b = iput_a + 1; // 计算再下一个写入索引位置
    if (iput_b == r->size) {
   
        iput_b = 0; // 如果再下一个索引超出了缓冲区大小，将其循环回0
    }
    if (iput_b