Skip to content

Commit 94c6b78

Browse files
authored
Merge pull request #594 from danielinux/docfix-ext_flash_read
Fixed misaligned documentation (ext_flash_read return value)
2 parents b0f0de9 + 6030e15 commit 94c6b78

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/HAL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ This function provides an indirect read of the external memory, using the
100100
driver's specific interface. `address` is the offset from the beginning of the
101101
addressable space in the device, `data` is a pointer where payload is stored upon a successful
102102
call, and `len` is the maximum size allowed for the payload. This function must be able to handle
103-
reads of any size and alignment. `ext_flash_read` should return 0 upon success, or a negative value
104-
in case of failure.
103+
reads of any size and alignment. `ext_flash_read` should return the number of bytes read
104+
on success, or a negative value in case of failure.
105105

106106
`int ext_flash_erase(uintptr_t address, int len)`
107107

0 commit comments

Comments
 (0)