aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/README.md b/README.md
index 1b9a692..cdab1d4 100644
--- a/README.md
+++ b/README.md
@@ -219,7 +219,7 @@ dispatching inferences to the Ethos-U kernel driver.
As the component diagram below illustrates the network is separated from the
inference, allowing multiple inferences to share the same network. The buffer
-class is used to store any data.
+class is used to store IFM and OFM data.
![Driver library](docs/driver_library_component.svg "Driver library component diagram")
@@ -232,9 +232,9 @@ The `Device` class opens a file descriptor to the device node `/dev/ethosu<nr>`.
This file descriptor is used to issue IOCTL request to kernel space to create
buffers and networks.
-The `Network` class uses the `Device` object to create a new network object. The
-network model is stored in a `Buffer` that the network parses to discover the
-dimensions of the network model.
+The `Network` class uses the `Device` object to create a new network object.
+The network model is provided in a user buffer that is copied into an internal
+buffer and parsed to discover the dimensions of the network model.
The `Inference` class uses the `Network` object to create an inference. The
array of IFM `Buffers` need to be populated with data before the inference
@@ -259,13 +259,11 @@ for reading and/or writing.
## Network
Creating a network assumes that the device node has already been opened, and
-that a buffer has been allocated and populated with the network model.
+that a user buffer populated with the network model is available.
A new network is created by issuing an IOCTL command on the device node file
-descriptor. A file descriptor to a buffer - containing the network model - is
-passed in the IOCTL data. The network class increases the reference count on the
-buffer, preventing the buffer from being freed before the network object has
-been destructed.
+descriptor. A pointer to the user buffer - containing the network model - and
+its size is passed in the IOCTL data.
![Create network](docs/kernel_network.svg "Create network")