summaryrefslogtreecommitdiff
path: root/cleopatre/doc/mme_specs/chapter_ms_mme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'cleopatre/doc/mme_specs/chapter_ms_mme.rst')
-rw-r--r--cleopatre/doc/mme_specs/chapter_ms_mme.rst269
1 files changed, 269 insertions, 0 deletions
diff --git a/cleopatre/doc/mme_specs/chapter_ms_mme.rst b/cleopatre/doc/mme_specs/chapter_ms_mme.rst
new file mode 100644
index 0000000000..5a34de68d1
--- /dev/null
+++ b/cleopatre/doc/mme_specs/chapter_ms_mme.rst
@@ -0,0 +1,269 @@
+Manufacturer specific MME
+*************************
+
+
+Presentation
+============
+
+All manufacturer specific messages are able to transmitted through the Ethernet medium only.
+They are all destinated to the PLC daemon running under Linux and must not be forwarded to the PLC layer.
+
+They are used by an external software application during the manufacturing process.
+
+**Warning:** MMENTRY part of vendor specific messages contain 3 bytes of SPiDCOM OUI (0x00-0x13-0xd7).
+
+Manufacturer specific MME list
+==============================
+
++--------+---------------------+-----------+
+| MMTYPE | Label | CCO level |
++========+=====================+===========+
+| 0x800C | MS_SET_NVRAM.REQ | 0 |
++ +---------------------+ +
+| | MS_SET_NVRAM.CNF | |
++--------+---------------------+-----------+
+| 0x8010 | MS_SET_SELFTEST.REQ | 0 |
++ +---------------------+ +
+| | MS_SET_SELFTEST.CNF | |
++ +---------------------+ +
+| | MS_SET_SELFTEST.IND | |
++--------+---------------------+-----------+
+| 0x8014 | MS_SET_IMAGE.REQ | 0 |
++ +---------------------+ +
+| | MS_SET_IMAGE.CNF | |
++--------+---------------------+-----------+
+| 0x8018 | MS_SET_TONEMASK.REQ | 0 |
++ +---------------------+ +
+| | MS_SET_TONEMASK.CNF | |
++--------+---------------------+-----------+
+
+Manufacturer specific MME description
+=====================================
+
+Set the NVRAM content (MS_SET_NVRAM)
+------------------------------------
+
+MS_SET_NVRAM.REQ (0x800C)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Block Index
+ - 0
+ - 1
+ - NVRAM 1024kB block index. Writing to block #0 implies the whole NVRAM space erasing.
+
+ 0x00 – 0x3f = block index
+
+ 0x40 \- 0xff = Reserved
+
+ * - Data
+ - 1
+ - 1024
+ - NVRAM data
+
+MS_SET_NVRAM.CNF (0x800D)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Result
+ - 0
+ - 1
+ - 0x00 = Success
+
+ 0x01 = Failure
+
+ 0x02 \- 0xff = Reserved
+
+Start the self-test process (MS_SET_SELFTEST)
+---------------------------------------------
+
+MS_SET_SELFTEST.REQ (0x8010)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Test
+ - 0
+ - 2
+ - Self\-test mask:
+
+ 0x0001 = SDRAM test
+
+ 0x0002 = UART0 test (need loopback plug)
+
+ 0x0004 = UART1 test (need loopback plug)
+
+ 0x0008 = ETH PHY loopback test
+
+ 0x0010 = PCM test
+
+ 0x0020 = I2S test
+
+ 0x0040 = MPEG test
+
+ 0x0100 = customer's auto\-test
+
+MS_SET_SELFTEST.CNF (0x8011)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Result
+ - 0
+ - 1
+ - 0x00 = Success
+
+ 0x01 = Failure
+
+ 0x02 \- 0xff = Reserved
+
+MS_SET_SELFTEST.IND (0x0812)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Report
+ - 0
+ - ...
+ - Self\-test report in text format.
+
+Switch current software image (MS_SET_IMAGE)
+--------------------------------------------
+
+MS_SET_IMAGE.REQ (0x8014)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Image Index
+ - 0
+ - 1
+ - Index of image to set as current.
+
+ 0x00 = image #0
+
+ 0x01 = image #1
+
+ 0x02 \- 0xfe = Reserved
+
+ 0xff = switch images
+
+MS_SET_IMAGE.CNF (0x8015)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Result
+ - 0
+ - 1
+ - 0x00 = Success
+
+ 0x01 = Failure
+
+ 0x02 = Chosen image not valid
+
+ 0x03 \- 0xff = Reserved
+
+ * - Image Index
+ - 1
+ - 1
+ - New current image index.
+
+Set the tonemask (MS_SET_TONEMASK)
+----------------------------------
+
+MS_SET_TONEMASK.REQ (0x8018)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Tonemask
+ - 0
+ - 192
+ - Tonemask bitfield for the 1536 carriers from 0 MHz to 37.5 MHzwith:
+
+ 0b0 = carrier is unmasked
+
+ 0b1 = carrier is masked
+
+ The byte 0 contains the activation bits for the first 8 carriers, the byte 1 contains the activation bits for the second 8 carriers, and so on.
+
+MS_SET_TONEMASK.CNF (0x8019)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+ :widths: 7 6 6 60
+ :header-rows: 1
+
+ * - Field
+ - Octet number
+ - Field size (octets)
+ - Definition
+
+ * - Result
+ - 0
+ - 1
+ - 0x00 = Success
+
+ 0x01 = Failure
+
+ 0x02 \- 0xff = Reserved
+