From 320f17550ae23c6f20b77aa8f95b88eef3d8135f Mon Sep 17 00:00:00 2001 From: Sudeep Mohanty Date: Wed, 7 Sep 2022 14:13:05 +0200 Subject: [PATCH] docs: Updated description of ULP FSM shift operations This commit updates the documentation for ULP FSM LSH and RSH operations. Closes https://github.com/espressif/esp-idf/issues/8831 --- docs/en/api-guides/ulp_instruction_set.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/en/api-guides/ulp_instruction_set.rst b/docs/en/api-guides/ulp_instruction_set.rst index 64964bc3a3..6db24f90e2 100644 --- a/docs/en/api-guides/ulp_instruction_set.rst +++ b/docs/en/api-guides/ulp_instruction_set.rst @@ -281,6 +281,9 @@ The detailed description of all instructions is presented below: **Description** The instruction does a logical shift to left of the source register by the number of bits from another source register or a 16-bit signed value and stores the result to the destination register. +.. note:: + Shift operations which are greater than 15 bits will have an undefined result. + **Examples**:: 1: LSH R1, R2, R3 // R1 = R2 << R3 @@ -316,6 +319,9 @@ The detailed description of all instructions is presented below: **Description** The instruction does a logical shift to right of a source register by the number of bits from another source register or a 16-bit signed value and stores the result to the destination register. +.. note:: + Shift operations which are greater than 15 bits will have an undefined result. + **Examples**:: 1: RSH R1, R2, R3 // R1 = R2 >> R3