Sfoglia il codice sorgente

Merge branch 'docs/update_ulp_shift_ops_description' into 'master'

docs: Updated description of ULP FSM shift operations

Closes IDFGH-7237

See merge request espressif/esp-idf!20025
Sudeep Mohanty 3 anni fa
parent
commit
751bca40f7
1 ha cambiato i file con 6 aggiunte e 0 eliminazioni
  1. 6 0
      docs/en/api-reference/system/ulp_instruction_set.rst

+ 6 - 0
docs/en/api-reference/system/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