BMLib User Guide

发布记录

版本	发布时间	说明
V2.1.0	2020/07/29	第一次发布
V2.1.1	2020/11/23	1、新增设备间device memory 搬运api 2、新增按照heap_mask_id 分配gmem api
V2.3.0	2021/01/08	修改统一参数介绍
V2.3.1	2021/12/05	新增bm_mem_vir_to_phy接口

目录

• 1. 声明
• 2. 快速开始
  • 2.1. 术语解释
  • 2.2. 授权和版本
    • 2.2.1. 授权
    • 2.2.2. 版本信息
• 3. Bmlib的基本概念和功能
  • 3.1. Handle的概念
  • 3.2. Memory的种类
  • 3.3. Api的概念和同步
  • 3.4. Profile接口
  • 3.5. A53的使能
  • 3.6. Power控制
  • 3.7. 杂项信息接口
• 4. bmlib详细接口介绍
  • 4.1. 设备handle的创建和销毁
    • 4.1.1. bm_dev_getcount
    • 4.1.2. bm_dev_query
    • 4.1.3. bm_dev_request
    • 4.1.4. bm_get_devid
    • 4.1.5. bm_dev_free
  • 4.2. memory help函数接口
    • 4.2.1. bm_mem_get_type
    • 4.2.2. bm_mem_get_device_addr
    • 4.2.3. bm_mem_set_device_addr
    • 4.2.4. bm_mem_get_device_size
    • 4.2.5. bm_mem_set_device_size
    • 4.2.6. bm_set_device_mem
    • 4.2.7. bm_mem_from_device
    • 4.2.8. bm_mem_get_system_addr
    • 4.2.9. bm_mem_set_system_addr
    • 4.2.10. bm_mem_from_system
  • 4.3. Global memory的申请和释放
    • 4.3.1. bm_mem_null
    • 4.3.2. bm_malloc_neuron_device
    • 4.3.3. bm_malloc_device_dword
    • 4.3.4. bm_malloc_device_byte
    • 4.3.5. bm_malloc_device_byte_heap
    • 4.3.6. bm_malloc_device_byte_heap_mask
    • 4.3.7. bm_free_device
    • 4.3.8. bm_gmem_arm_reserved_request
    • 4.3.9. bm_gmem_arm_reserved_release
  • 4.4. 数据在host和global memory之间的搬运
    • 4.4.1. bm_memcpy_s2d
    • 4.4.2. bm_memcpy_s2d_partial_offset
    • 4.4.3. bm_memcpy_s2d_partial
    • 4.4.4. bm_memcpy_d2s
    • 4.4.5. bm_memcpy_d2s_partial_offset
    • 4.4.6. bm_memcpy_d2s_partial
    • 4.4.7. bm_mem_convert_system_to_device_neuron
    • 4.4.8. bm_mem_convert_system_to_device_neuron_byte
    • 4.4.9. bm_mem_convert_system_to_device_coeff
    • 4.4.10. bm_mem_convert_system_to_device_coeff_byte
  • 4.5. 数据在global memory内部的搬运
    • 4.5.1. bm_memcpy_d2d
    • 4.5.2. bm_memcpy_d2d_byte
    • 4.5.3. bm_memcpy_d2d_stride
    • 4.5.4. bm_memset_device
    • 4.5.5. bm_memset_device_ext
  • 4.6. Global memory 在不同设备间搬运
    • 4.6.1. bm_memcpy_c2c
  • 4.7. Global memory在host端的映射和一致性管理
    • 4.7.1. bm_mem_mmap_device_mem
    • 4.7.2. bm_mem_invalidate_device_mem
    • 4.7.3. bm_mem_invalidate_partial_device_mem
    • 4.7.4. bm_mem_flush_device_mem
    • 4.7.5. bm_mem_flush_partial_device_mem
    • 4.7.6. bm_mem_unmap_device_mem
    • 4.7.7. bm_mem_vir_to_phy
  • 4.8. API的同步
    • 4.8.1. bm_flush
    • 4.8.2. bm_device_sync
    • 4.8.3. bm_thread_sync
    • 4.8.4. bm_handle_sync
  • 4.9. profile接口
    • 4.9.1. bm_get_profile
    • 4.9.2. bm_get_last_api_process_time_us
  • 4.10. power管理接口
    • 4.10.1. bm_set_clk_tpu_freq
    • 4.10.2. bm_get_clk_tpu_freq
  • 4.11. 设备管理接口
    • 4.11.1. bm_get_misc_info
    • 4.11.2. bm_get_chipid
    • 4.11.3. bm_get_stat
    • 4.11.4. bm_get_gmem_heap_id
    • 4.11.5. bmlib_log_get_level
    • 4.11.6. bmlib_log_set_level
    • 4.11.7. bmlib_log_set_callback
    • 4.11.8. bm_set_debug_mode
    • 4.11.9. bmlib_set_api_dbg_callback
    • 4.11.10. bm_get_tpu_current
    • 4.11.11. bm_get_board_max_power
    • 4.11.12. bm_get_board_power
    • 4.11.13. bm_get_fan_speed
    • 4.11.14. bm_get_ecc_correct_num
    • 4.11.15. bm_get_12v_atx
    • 4.11.16. bm_get_sn
    • 4.11.17. bm_get_status
    • 4.11.18. bm_get_tpu_minclk
    • 4.11.19. bm_get_tpu_maxclk
    • 4.11.20. bm_get_driver_version
    • 4.11.21. bm_get_board_name
    • 4.11.22. bm_get_board_temp
    • 4.11.23. bm_get_chip_temp
    • 4.11.24. bm_get_tpu_power
    • 4.11.25. bm_get_tpu_volt
• 5. 相关数据结构定义
  • 5.1. bm_status_t
  • 5.2. bm_mem_type_t
  • 5.3. bm_mem_flags_t
  • 5.4. bm_mem_desc_t
  • 5.5. bm_misc_info
  • 5.6. bm_profile_t
  • 5.7. bm_heap_stat
  • 5.8. bm_dev_stat_t
  • 5.9. bm_log_level