summaryrefslogtreecommitdiff
path: root/docs/source/api/api_common.rst
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2022-04-10 18:05:49 +0800
committersakumisu <[email protected]>2022-04-10 18:05:49 +0800
commit9ffb6382384c539e4d0ad5cdf75dc154e6537865 (patch)
tree6eb9cab84f1433de5fc7ca69837a3c3ffe9aef8e /docs/source/api/api_common.rst
parent065a0a4a0b0c8c860e081db27832625ea2d58da8 (diff)
update rst
Diffstat (limited to 'docs/source/api/api_common.rst')
-rw-r--r--docs/source/api/api_common.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/api/api_common.rst b/docs/source/api/api_common.rst
index 6f743643..3c4653d9 100644
--- a/docs/source/api/api_common.rst
+++ b/docs/source/api/api_common.rst
@@ -1,2 +1,48 @@
其他
=========================
+
+usb_malloc
+""""""""""""""""""""""""""""""""""""
+
+``usb_malloc`` 用来申请内存。
+
+.. code-block:: C
+
+ void *usb_malloc(size_t size);
+
+- **size** 要申请的内存大小
+- **return** 申请的内存地址
+
+usb_free
+""""""""""""""""""""""""""""""""""""
+
+``usb_free`` 用来释放申请的内存。
+
+.. code-block:: C
+
+ void usb_free(void *ptr);
+
+- **ptr** 要释放的内存地址
+
+usb_iomalloc
+""""""""""""""""""""""""""""""""""""
+
+``usb_iomalloc`` 用来申请内存,并按照 `CONFIG_DCACHE_LINE_SIZE` 对齐,一般使用到 dcache 和 dma 需要对齐操作的时候使用。
+
+.. code-block:: C
+
+ void *usb_iomalloc(size_t size);
+
+- **size** 要申请的内存大小
+- **return** 申请的内存地址
+
+usb_iofree
+""""""""""""""""""""""""""""""""""""
+
+``usb_iofree`` 用来释放申请的内存。
+
+.. code-block:: C
+
+ void usb_iofree(void *ptr);
+
+- **ptr** 要释放的内存地址