Skip to content

Commit f03c3fb

Browse files
AnotherButlerAnotherButler
authored andcommitted
Copy edit QUICKSTART.md
Edit new section for active voice and consistent person. REVIEW REQUIRED
1 parent bcba7d2 commit f03c3fb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/api/QUICKSTART.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -310,13 +310,13 @@ If the LED is blinking, the app is running correctly. If you press the `SW2` but
310310
## Expose public secure entry points to the secure box
311311
[Go to top](#overview)
312312

313-
So far, the code in the secure box cannot communicate to other boxes. To let other boxes call functions in our secure box you can define public secure entry points. These entry points can map to private functions within the context of a secure box, and the arguments and return values are automatically serialized using an RPC protocol to ensure no private memory can be leaked to external boxes.
313+
So far, the code in the secure box cannot communicate to other boxes. To let other boxes call functions in our secure box, you can define public secure entry points. These entry points can map to private functions within the context of a secure box, and an RPC protocol automatically serializes the arguments and return values to ensure no private memory can leak to external boxes.
314314

315-
You can define a public secure entry point to retrieve the index value from the secure box. This index value is increased every time the `SW2` button is pressed.
315+
You can define a public secure entry point to retrieve the index value from the secure box. This index value increases every time you press the `SW2` button.
316316

317317
### Defining a secure entry point
318318

319-
Create a new source file, `~/code/uvisor-example/source/secure_box.h`, where we will define the functions that can be called through RPC.
319+
Create a new source file, `~/code/uvisor-example/source/secure_box.h`, where you will define the functions that you can call through RPC.
320320

321321
```cpp
322322
/* ~/code/uvisor-example/source/secure_box.h */
@@ -333,7 +333,7 @@ UVISOR_EXTERN int (*secure_get_index)(void);
333333

334334
### Implementing a secure entry point
335335

336-
Now that you have defined the secure entry point, you can map the entry point to a function running in the secure box. This is done through the `UVISOR_BOX_RPC_GATEWAY_SYNC` macro. Open `~/code/uvisor-example/source/secure_box.cpp`, and replace the line with `#define PRIVATE_BUTTON_BUFFER_COUNT 8` by:
336+
Now that you have defined the secure entry point, you can map the entry point to a function running in the secure box. You can do this through the `UVISOR_BOX_RPC_GATEWAY_SYNC` macro. Open `~/code/uvisor-example/source/secure_box.cpp`, and replace the line with `#define PRIVATE_BUTTON_BUFFER_COUNT 8` by:
337337

338338
```cpp
339339
/* ~/code/uvisor-example/source/secure_box.cpp */
@@ -389,15 +389,15 @@ static void private_button_main_thread(const void *)
389389

390390
### Calling the public secure entry point
391391

392-
To call the public secure entry point from any other box, you can use the `secure_get_index` function. It will automatically do an RPC call into the secure box and serialize the return value. You can try this out from the main box. In `~/code/uvisor-example/source/main.cpp`, first include the header file for the secure box:
392+
To call the public secure entry point from any other box, you can use the `secure_get_index` function. It will automatically do an RPC call into the secure box and serialize the return value. You can try this from the main box. In `~/code/uvisor-example/source/main.cpp`, first include the header file for the secure box:
393393

394394
```cpp
395395
/* ~/code/uvisor-example/source/main.cpp */
396396

397397
#include "secure-box.h"
398398
```
399399

400-
And then replace the `main` function with:
400+
Then replace the `main` function with:
401401

402402
```cpp
403403
/* ~/code/uvisor-example/source/main.cpp */
@@ -412,7 +412,7 @@ int main(void)
412412
}
413413
```
414414
415-
You can observe the secure index by opening a serial port connection to the device, with a baud rate of 9600. When you press the `SW2` button the index will be increased.
415+
You can observe the secure index by opening a serial port connection to the device with a baud rate of 9600. When you press the `SW2` button, the index will increase.
416416
417417
## The NVIC APIs
418418

0 commit comments

Comments
 (0)