已关闭
修改单位格式不规范问题 #162533
修改单位格式不规范问题 #162533
已关闭
jiaojunying创建于 8 天前关闭于 8 天前
18 个文件变更+27-27
@@ -31,6 +31,6 @@ typedef struct DDK_Ashmem {...} DDK_Ashmem
31| const uint32_t size | 缓冲区大小。 |31| const uint32_t size | 缓冲区大小。 |
32| uint32_t offset | 已使用缓冲区的偏移量。默认值为0,表示没有偏移,缓冲区从address指定地址开始。offset与bufferLength之和不超过size,否则会导致越界访问。 |32| uint32_t offset | 已使用缓冲区的偏移量。默认值为0,表示没有偏移,缓冲区从address指定地址开始。offset与bufferLength之和不超过size,否则会导致越界访问。 |
33| uint32_t bufferLength | 使用的缓冲区长度。该值在默认情况下等于size(表示使用整个缓冲区),且offset与bufferLength之和不能大于size,否则会导致越界访问。 |33| uint32_t bufferLength | 使用的缓冲区长度。该值在默认情况下等于size(表示使用整个缓冲区),且offset与bufferLength之和不能大于size,否则会导致越界访问。 |
34-| uint32_t transferredLength | 已传输数据的长度。单位:字节。在数据传输完成后由接口更新。 |34+| uint32_t transferredLength | 已传输数据的长度。单位:Byte。在数据传输完成后由接口更新。 |
35 35 
36 36 
@@ -27,6 +27,6 @@ typedef struct Hid_AbsAxesArray {...} Hid_AbsAxesArray
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| [Hid_AbsAxes](capi-hid-ddk-types-h.md#hid_absaxes)* hidAbsAxes | 指向绝对坐标属性编码数组首元素的指针。需与length配合使用,指针需有效且不为 NULL。 |29| [Hid_AbsAxes](capi-hid-ddk-types-h.md#hid_absaxes)* hidAbsAxes | 指向绝对坐标属性编码数组首元素的指针。需与length配合使用,指针需有效且不为 NULL。 |
30-| uint16_t length | 数组的有效长度,表示hidAbsAxes指针指向的有效元素个数。取值范围:0~65535。 |30+| uint16_t length | 数组的有效长度,表示hidAbsAxes指针指向的有效元素个数。取值范围:[0, 65535]。 |
31 31 
32 32 
@@ -392,7 +392,7 @@ int32_t OH_ScsiPeripheral_CreateDeviceMemMap(ScsiPeripheral_Device *dev, size_t
392| 参数项 | 描述 |392| 参数项 | 描述 |
393|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|393|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
394| [ScsiPeripheral_Device](capi-scsiperipheralddk-scsiperipheral-device.md) *dev | 设备句柄,详情参见[ScsiPeripheral_Device](capi-scsiperipheralddk-scsiperipheral-device.md)。 |394| [ScsiPeripheral_Device](capi-scsiperipheralddk-scsiperipheral-device.md) *dev | 设备句柄,详情参见[ScsiPeripheral_Device](capi-scsiperipheralddk-scsiperipheral-device.md)。 |
395-| size_t size | 缓冲区的大小,单位:字节。|395+| size_t size | 缓冲区的大小,单位:Byte。|
396| [ScsiPeripheral_DeviceMemMap](capi-scsiperipheralddk-scsiperipheral-devicememmap.md) **devMmap | 创建的缓冲区通过该参数返回给调用者,详情参见[ScsiPeripheral_DeviceMemMap](capi-scsiperipheralddk-scsiperipheral-devicememmap.md)。 |396| [ScsiPeripheral_DeviceMemMap](capi-scsiperipheralddk-scsiperipheral-devicememmap.md) **devMmap | 创建的缓冲区通过该参数返回给调用者,详情参见[ScsiPeripheral_DeviceMemMap](capi-scsiperipheralddk-scsiperipheral-devicememmap.md)。 |
397 397 
398**返回:**398**返回:**
@@ -444,7 +444,7 @@ int32_t OH_ScsiPeripheral_ParseBasicSenseInfo(uint8_t *senseData, uint8_t senseD
444| 参数项 | 描述 |444| 参数项 | 描述 |
445| -- | -- |445| -- | -- |
446| uint8_t *senseData | 待解析的Sense Data。 |446| uint8_t *senseData | 待解析的Sense Data。 |
447-| uint8_t senseDataLen | Sense Data长度,即senseData参数指向的数据长度,单位:字节。 |447+| uint8_t senseDataLen | Sense Data长度,即senseData参数指向的数据长度,单位:Byte。 |
448| [ScsiPeripheral_BasicSenseInfo](capi-scsiperipheralddk-scsiperipheral-basicsenseinfo.md) *senseInfo | 用于保存解析后的基本信息,详情参见[ScsiPeripheral_BasicSenseInfo](capi-scsiperipheralddk-scsiperipheral-basicsenseinfo.md)。 |448| [ScsiPeripheral_BasicSenseInfo](capi-scsiperipheralddk-scsiperipheral-basicsenseinfo.md) *senseInfo | 用于保存解析后的基本信息,详情参见[ScsiPeripheral_BasicSenseInfo](capi-scsiperipheralddk-scsiperipheral-basicsenseinfo.md)。 |
449 449 
450**返回:**450**返回:**
@@ -27,6 +27,6 @@ SCSI READ CAPACITY结构体。用于在开发SCSI设备驱动时获取设备的
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| uint32_t lbAddress | 返回的逻辑块地址,表示可寻址的最后一块逻辑块的编号,逻辑块总数为该值加1。 |29| uint32_t lbAddress | 返回的逻辑块地址,表示可寻址的最后一块逻辑块的编号,逻辑块总数为该值加1。 |
30-| uint32_t lbLength | 单个逻辑块长度(单位:字节)。表示每个逻辑块的字节大小,通常为512、2048或4096等标准值,具体取决于设备类型和格式化方式。 |30+| uint32_t lbLength | 单个逻辑块长度(单位:Byte)。表示每个逻辑块的字节大小,通常为512、2048或4096等标准值,具体取决于设备类型和格式化方式。 |
31 31 
32 32 
@@ -27,9 +27,9 @@ typedef struct ScsiPeripheral_DeviceMemMap {...} ScsiPeripheral_DeviceMemMap
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| uint8_t* const address | 设备内存映射的缓冲区起始地址,指向映射的设备内存空间。该缓冲区用于存储SCSI设备数据,提供高性能的内存访问能力。 |29| uint8_t* const address | 设备内存映射的缓冲区起始地址,指向映射的设备内存空间。该缓冲区用于存储SCSI设备数据,提供高性能的内存访问能力。 |
30-| const size_t size | 缓冲区大小,单位:字节。取值原则:必须大于0。 |30+| const size_t size | 缓冲区大小,单位:Byte。取值原则:必须大于0。 |
31-| uint32_t offset | 缓冲区读写起始偏移量,单位:字节。默认值为0,表示没有偏移,缓冲区从指定地址开始。取值范围为[0, size],当需要从缓冲区特定位置开始读写时设置此参数,不同的offset值对应不同的起始读写位置。 |31+| uint32_t offset | 缓冲区读写起始偏移量,单位:Byte。默认值为0,表示没有偏移,缓冲区从指定地址开始。取值范围为[0, size],当需要从缓冲区特定位置开始读写时设置此参数,不同的offset值对应不同的起始读写位置。 |
32-| uint32_t bufferLength | 要使用的缓冲区长度,单位:字节。默认情况下,该值等于缓冲区的大小,表示整个缓冲区都被使用。当只使用缓冲区的一部分时设置此参数,bufferLength加offset的值应小于等于size。 |32+| uint32_t bufferLength | 要使用的缓冲区长度,单位:Byte。默认情况下,该值等于缓冲区的大小,表示整个缓冲区都被使用。当只使用缓冲区的一部分时设置此参数,bufferLength加offset的值应小于等于size。 |
33-| uint32_t transferredLength | 已传输数据的长度,单位:字节。初始值为0,表示尚未传输任何数据。该字段在SCSI数据传输完成后更新,表示实际传输的数据量,可用于监控传输进度。 |33+| uint32_t transferredLength | 已传输数据的长度,单位:Byte。初始值为0,表示尚未传输任何数据。该字段在SCSI数据传输完成后更新,表示实际传输的数据量,可用于监控传输进度。 |
34 34 
35 35 
@@ -27,9 +27,9 @@ SCSI命令(INQUIRY)的请求结构体,通常用于查询设备的基本信
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| uint8_t pageCode | Page code字段。获取设备的某些特定类型的信息时使用。当发出带有特定页面代码的 Inquiry 命令时,设备会返回与该页面代码相关的详细信息。如果 page code 设置为 0x00,则表示请求的是标准的 Inquiry 数据,而非特定页面的数据。 |29| uint8_t pageCode | Page code字段。获取设备的某些特定类型的信息时使用。当发出带有特定页面代码的 Inquiry 命令时,设备会返回与该页面代码相关的详细信息。如果 page code 设置为 0x00,则表示请求的是标准的 Inquiry 数据,而非特定页面的数据。 |
30-| uint16_t allocationLength | Allocation length字段,用于指定请求发起者(通常是主机)为响应数据准备的缓冲区大小。单位:字节。 |30+| uint16_t allocationLength | Allocation length字段,用于指定请求发起者(通常是主机)为响应数据准备的缓冲区大小。单位:Byte。 |
31| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |31| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |
32| uint8_t byte1 | CDB(Command Descriptor Block,命令描述符块)的第一个字节。 |32| uint8_t byte1 | CDB(Command Descriptor Block,命令描述符块)的第一个字节。 |
33-| uint32_t timeout | 超时时间(单位:毫秒)。 |33+| uint32_t timeout | 超时时间(单位:ms)。 |
34 34 
35 35 
@@ -32,6 +32,6 @@ typedef struct ScsiPeripheral_IORequest {...} ScsiPeripheral_IORequest
32| uint8_t byte1 | SCSI命令描述符块(CDB)的第一个字节,通常包含操作码和操作组信息。 |32| uint8_t byte1 | SCSI命令描述符块(CDB)的第一个字节,通常包含操作码和操作组信息。 |
33| uint8_t byte6 | SCSI命令描述符块(CDB)的第六个字节,根据命令类型包含不同的参数或标志信息。 |33| uint8_t byte6 | SCSI命令描述符块(CDB)的第六个字节,根据命令类型包含不同的参数或标志信息。 |
34| [ScsiPeripheral_DeviceMemMap](capi-scsiperipheralddk-scsiperipheral-devicememmap.md)* data | 数据传输的缓冲区。 |34| [ScsiPeripheral_DeviceMemMap](capi-scsiperipheralddk-scsiperipheral-devicememmap.md)* data | 数据传输的缓冲区。 |
35-| uint32_t timeout | 超时时间(单位:毫秒)。 |35+| uint32_t timeout | 超时时间(单位:ms)。 |
36 36 
37 37 
@@ -29,6 +29,6 @@ SCSI命令(READ CAPACITY)的请求结构体,用于发送读取存储容量
29| uint32_t lbAddress | 逻辑块地址,用于指定读取容量的起始逻辑块位置。取值为0时获取设备整体容量信息。 |29| uint32_t lbAddress | 逻辑块地址,用于指定读取容量的起始逻辑块位置。取值为0时获取设备整体容量信息。 |
30| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |30| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |
31| uint8_t byte8 | CDB(Command Descriptor Block,命令描述符块)的第八个字节。 |31| uint8_t byte8 | CDB(Command Descriptor Block,命令描述符块)的第八个字节。 |
32-| uint32_t timeout | 超时时间(单位:毫秒)。 |32+| uint32_t timeout | 超时时间(单位:ms)。 |
33 33 
34 34 
@@ -26,9 +26,9 @@ SCSI命令(REQUEST SENSE)的请求结构体,该命令通常用于获取设
26 26 
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29-| uint8_t allocationLength | Allocation length字段,指定了请求发起者(通常是主机)为响应数据准备的缓冲区大小,单位:字节。 |29+| uint8_t allocationLength | Allocation length字段,指定了请求发起者(通常是主机)为响应数据准备的缓冲区大小,单位:Byte。 |
30| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |30| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |
31| uint8_t byte1 | CDB(Command Descriptor Block,命令描述符块)的第一个字节。 |31| uint8_t byte1 | CDB(Command Descriptor Block,命令描述符块)的第一个字节。 |
32-| uint32_t timeout | 超时时间(单位:毫秒)。 |32+| uint32_t timeout | 超时时间(单位:ms)。 |
33 33 
34 34 
@@ -34,6 +34,6 @@ SCSI响应参数结构体,包含状态、错误诊断数据、传输结果等
34| uint16_t hostStatus | 主机适配器状态。例如:成功(0x00)、无法连接(0x01)、总线忙(0x02)、超时(0x03)。 |34| uint16_t hostStatus | 主机适配器状态。例如:成功(0x00)、无法连接(0x01)、总线忙(0x02)、超时(0x03)。 |
35| uint16_t driverStatus | 驱动状态。例如:成功(0x00)、设备或资源忙(0x01)。 |35| uint16_t driverStatus | 驱动状态。例如:成功(0x00)、设备或资源忙(0x01)。 |
36| int32_t resId | 实际传输的数据长度差值,即未传输的字节数。 |36| int32_t resId | 实际传输的数据长度差值,即未传输的字节数。 |
37-| uint32_t duration | 执行SCSI命令消耗的时间(单位:毫秒)。 |37+| uint32_t duration | 执行SCSI命令消耗的时间(单位:ms)。 |
38 38 
39 39 
@@ -27,6 +27,6 @@ SCSI命令(TEST UNIT READY)的请求结构体,通常用于确认逻辑单
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |29| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |
30-| uint32_t timeout | 超时时间(单位:毫秒)。 |30+| uint32_t timeout | 超时时间(单位:ms)。 |
31 31 
32 32 
@@ -31,6 +31,6 @@ SCSI命令(VERIFY)的请求结构体,该命令通常用于校验逻辑块
31| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |31| uint8_t control | Control字段,用于指定SCSI命令的控制信息。 |
32| uint8_t byte1 | CDB(Command Descriptor Block,命令描述符块)的第一个字节。 |32| uint8_t byte1 | CDB(Command Descriptor Block,命令描述符块)的第一个字节。 |
33| uint8_t byte6 | CDB(Command Descriptor Block,命令描述符块)的第六个字节。 |33| uint8_t byte6 | CDB(Command Descriptor Block,命令描述符块)的第六个字节。 |
34-| uint32_t timeout | 超时时间(单位:毫秒)。 |34+| uint32_t timeout | 超时时间(单位:ms)。 |
35 35 
36 36 
@@ -26,9 +26,9 @@ typedef struct UsbConfigDescriptor {...} __attribute__((packed)) UsbConfigDescri
26 26 
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29-| uint8_t bLength | 该描述符的大小,单位:字节。 |29+| uint8_t bLength | 该描述符的大小,单位:Byte。 |
30| uint8_t bDescriptorType | 描述符类型。 |30| uint8_t bDescriptorType | 描述符类型。 |
31-| uint16_t wTotalLength | 该配置描述符的总长度,包含配置、接口、端点和特定于类或供应商的描述符,单位:字节。 |31+| uint16_t wTotalLength | 该配置描述符的总长度,包含配置、接口、端点和特定于类或供应商的描述符,单位:Byte。 |
32| uint8_t bNumInterfaces | 该配置所支持的接口数量。 |32| uint8_t bNumInterfaces | 该配置所支持的接口数量。 |
33| uint8_t bConfigurationValue | 用于设置配置的参数,用来选择当前配置。 |33| uint8_t bConfigurationValue | 用于设置配置的参数,用来选择当前配置。 |
34| uint8_t iConfiguration | 描述该配置的字符串描述符的索引。 |34| uint8_t iConfiguration | 描述该配置的字符串描述符的索引。 |
@@ -26,7 +26,7 @@ typedef struct UsbDeviceDescriptor {...} __attribute__((aligned(8))) UsbDeviceDe
26 26 
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29-| uint8_t bLength | 该描述符的大小,单位:字节。 |29+| uint8_t bLength | 该描述符的大小,单位:Byte。 |
30| uint8_t bDescriptorType | 描述符类型。 |30| uint8_t bDescriptorType | 描述符类型。 |
31| uint16_t bcdUSB | USB协议版本号。 |31| uint16_t bcdUSB | USB协议版本号。 |
32| uint8_t bDeviceClass | 由USB标准化组织(USB-IF)分配的设备类代码。 |32| uint8_t bDeviceClass | 由USB标准化组织(USB-IF)分配的设备类代码。 |
@@ -27,9 +27,9 @@ typedef struct UsbDeviceMemMap {...} UsbDeviceMemMap
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| uint8_t* const address | 映射后的缓冲区地址。 |29| uint8_t* const address | 映射后的缓冲区地址。 |
30-| const size_t size | 缓冲区大小(单位:字节),必须大于 0。 |30+| const size_t size | 缓冲区大小(单位:Byte),必须大于 0。 |
31| uint32_t offset | 所使用的缓冲区的偏移量,默认为0,表示没有偏移。偏移从缓冲区地址address开始计算,offset和bufferLength之和必须小于等于缓冲区大小size。 |31| uint32_t offset | 所使用的缓冲区的偏移量,默认为0,表示没有偏移。偏移从缓冲区地址address开始计算,offset和bufferLength之和必须小于等于缓冲区大小size。 |
32| uint32_t bufferLength | 所使用的缓冲区的长度,默认等于缓冲区大小 size,表示使用全部的缓冲区。offset和bufferLength之和必须小于等于缓冲区大小size。 |32| uint32_t bufferLength | 所使用的缓冲区的长度,默认等于缓冲区大小 size,表示使用全部的缓冲区。offset和bufferLength之和必须小于等于缓冲区大小size。 |
33-| uint32_t transferedLength | 实际传输的数据长度(单位:字节)。 |33+| uint32_t transferedLength | 实际传输的数据长度(单位:Byte)。 |
34 34 
35 35 
@@ -26,11 +26,11 @@ typedef struct UsbEndpointDescriptor {...} __attribute__((packed)) UsbEndpointDe
26 26 
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29-| uint8_t bLength | 该描述符的大小,单位:字节。 |29+| uint8_t bLength | 该描述符的大小,单位:Byte。 |
30| uint8_t bDescriptorType | 描述符类型。 |30| uint8_t bDescriptorType | 描述符类型。 |
31| uint8_t bEndpointAddress | 端点地址,包含端点编号以及端点方向。 |31| uint8_t bEndpointAddress | 端点地址,包含端点编号以及端点方向。 |
32| uint8_t bmAttributes | 端点属性,包括传输类型、同步类型和使用类型。 |32| uint8_t bmAttributes | 端点属性,包括传输类型、同步类型和使用类型。 |
33-| uint16_t wMaxPacketSize | 该端点所能承载的最大包的大小,单位:字节。 |33+| uint16_t wMaxPacketSize | 该端点所能承载的最大包的大小,单位:Byte。 |
34| uint8_t bInterval | 数据传输时轮询端点的时间间隔。 |34| uint8_t bInterval | 数据传输时轮询端点的时间间隔。 |
35| uint8_t bRefresh | 用于音频类设备,同步反馈的速率。 |35| uint8_t bRefresh | 用于音频类设备,同步反馈的速率。 |
36| uint8_t bSynchAddress | 用于音频类设备,同步端点的地址。 |36| uint8_t bSynchAddress | 用于音频类设备,同步端点的地址。 |
@@ -26,7 +26,7 @@ typedef struct UsbInterfaceDescriptor {...} __attribute__((packed)) UsbInterface
26 26 
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29-| uint8_t bLength | 该描述符的大小,单位:字节。 |29+| uint8_t bLength | 该描述符的大小,单位:Byte。 |
30| uint8_t bDescriptorType | 描述符类型。 |30| uint8_t bDescriptorType | 描述符类型。 |
31| uint8_t bInterfaceNumber | 接口编号。 |31| uint8_t bInterfaceNumber | 接口编号。 |
32| uint8_t bAlternateSetting | 用来选择该接口的备用设置的值。 |32| uint8_t bAlternateSetting | 用来选择该接口的备用设置的值。 |
@@ -27,7 +27,7 @@ typedef struct UsbRequestPipe {...} __attribute__((aligned(8))) UsbRequestPipe
27| 名称 | 描述 |27| 名称 | 描述 |
28| -- | -- |28| -- | -- |
29| uint64_t interfaceHandle | 接口操作句柄,用于标识USB设备上的接口,由[OH_Usb_ClaimInterface](capi-usb-ddk-api-h.md#oh_usb_claiminterface)接口获取。 |29| uint64_t interfaceHandle | 接口操作句柄,用于标识USB设备上的接口,由[OH_Usb_ClaimInterface](capi-usb-ddk-api-h.md#oh_usb_claiminterface)接口获取。 |
30-| uint32_t timeout | 超时时间,单位:毫秒。值为0表示等待直到操作完成;非0值表示在指定毫秒数内未完成则超时。 |30+| uint32_t timeout | 超时时间,单位:ms。值为0表示等待直到操作完成;非0值表示在指定毫秒数内未完成则超时。 |
31| uint8_t endpoint | 要通信的端点的地址。 |31| uint8_t endpoint | 要通信的端点的地址。 |
32 32 
33 33