From ebe86fa32ad397f2f86bb39fdd0af18622a54a69 Mon Sep 17 00:00:00 2001 From: John Safranek Date: Fri, 29 Jul 2022 10:24:11 -0700 Subject: [PATCH] Update ReadMe 1. Add a section to the readme file discussing the thread priority for a wolfSSH thread with respect to the network stack thread's priority. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ac07c4a..fc5dd3f 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,16 @@ Ubuntu and macOS. This takes a wolfSSL directory and a wolfSSH directory and builds it into a single static library (libwolfssh.a) and the testsuite test tool. It uses a Makefile and has a preconfigured user_settings.h file. +# Configuration recommendations + +## wolfSSH Task Priority + +When setting up your thread that runs wolfSSL, it must have the same +or lower priority than the networking stack thread. For example, in FreeRTOS, +you may set the network stack thread's priority to 6 and the wolfSSH thread +to 8, or DEFAULTTASKPRIORITY. (In FreeRTOS, the lower the priority value +the higher the priority.) + # Support For any issues related to wolfSSL or wolfSSH, please open an