Skip to content

Commit

Permalink
update the readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
ddvk committed Nov 17, 2022
1 parent c598e7d commit b8f3816
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Xochitl function name | Xochitl function role | Notes
`wait` | Waits until the update-handling threads have started. This function is replaced by the client shim with a no-op to avoid conflicting with the server. | Calls `usleep(1000)`.
`shutdown` | Stops the update-handling threads. This function is replaced by the client shim with a no-op to avoid conflicting with the server. | Uses the string `Shutting down...`.
`getInstance` | Retrieves the instance of the singleton SWTCON class. This function is used by the server to interact with the screen. | Calls a function that itself calls `create` and `wait`.
`notify` | Called when the framebuffer has been updated, used for the Qt signal/slot connections needed for ScreenShare to work |

The client and the server both ship the [hardcoded addresses](https://github.com/ddvk/remarkable2-framebuffer/blob/master/src/shared/config.cpp#L13) for these functions for various releases.
If you get a message saying `Missing address for function […]`, it means that the release you’re running is not yet supported. Please report this in [this dedicated thread](https://github.com/ddvk/remarkable2-framebuffer/issues/18).
Expand Down
1 change: 1 addition & 0 deletions tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Before starting this tutorial, [download and install Ghidra](https://www.ghidra-
- ![Search Memory](images/05-search-memory.png)
- in "Search Value", put the *exact* search string with no typos. Partial search is okay, just be aware you might find partial string matches in other sections of code
- `update` search string: `Unable to complete update: invalid waveform (`
- `notify` is the second function in the switch, case 8 in the `update` function
- `create` search string: `Unable to start generator thread\n`
- `shutdown` search string: `Shutting down...`
- Click "Next". You should only find one result.
Expand Down

0 comments on commit b8f3816

Please sign in to comment.