MUP1 Protocol Configuration

1. Introduction

This document describes configuration options for the MUP1 (Management UART Protocol version 1) serial communication protocol.

2. Checksum Configuration

The MUP1 protocol supports configurable checksum types for frame integrity verification. Two checksum algorithms are available:

Checksum Type Value Description

internet

1

16-bit Internet checksum (RFC 1071). This is the default.

crc32

2

32-bit CRC32 Ethernet polynomial checksum.
The checksum configuration takes effect only after saving and rebooting. The device continues using the current checksum type until the next boot.
Both the host and device must use the same checksum type to communicate successfully. When changing the checksum type, update the MUP1 client tool configuration to match before rebooting.

2.1. Get Current Checksum Configuration

To retrieve the current MUP1 checksum configuration:

FETCH request message

- "/mchp-velocitysp-system:mup1-config"

FETCH response message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: internet

2.2. Set Checksum Type to CRC32

To change the checksum type to CRC32:

IPATCH request message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: crc32

Verify the change:

FETCH request message

- "/mchp-velocitysp-system:mup1-config"

FETCH response message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: crc32

2.3. Set Checksum Type to Internet (Default)

To change the checksum type back to Internet checksum:

IPATCH request message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: internet

Verify the change:

FETCH request message

- "/mchp-velocitysp-system:mup1-config"

FETCH response message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: internet

2.4. Save Configuration

To persist the checksum configuration across reboots, save the running configuration to startup configuration:

POST request message

- ? "/mchp-velocitysp-system:save-config"
  :

3. Feature Configuration

Individual MUP1 protocol features can be enabled or disabled via the mup1-features configuration leaf. This uses a bits type where each named bit controls both RX and TX for the corresponding feature.

Feature Bit Description

announce

0

MUP1 announce messages (TX at startup)

coap

1

MUP1 CoAP frames (RX/TX)

dtls

2

MUP1 DTLS frames (RX/TX)

ping

3

MUP1 ping/pong (RX/TX)

trace

4

MUP1 trace messages (TX)
Feature changes take effect immediately without requiring a reboot. By default, all features are enabled.
Disabling the coap feature will prevent all CoAP management access over MUP1. Disabling dtls will prevent secure CoAP (CoAPS) access. Ensure alternative management access is available before disabling these features.

3.1. Get Current Feature Configuration

To retrieve the current MUP1 feature configuration:

FETCH request message

- "/mchp-velocitysp-system:mup1-config"

FETCH response message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: internet
    mup1-features: announce coap dtls ping trace

3.2. Disable a Feature (Ping)

To disable the ping feature while keeping all other features enabled:

IPATCH request message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-features: announce coap dtls trace

Verify the change:

FETCH request message

- "/mchp-velocitysp-system:mup1-config"

FETCH response message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: internet
    mup1-features: announce coap dtls trace

3.3. Re-enable All Features

To re-enable all features:

IPATCH request message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-features: announce coap dtls ping trace

Verify the change:

FETCH request message

- "/mchp-velocitysp-system:mup1-config"

FETCH response message

- ? "/mchp-velocitysp-system:mup1-config"
  : mup1-checksum: internet
    mup1-features: announce coap dtls ping trace

3.4. Save Feature Configuration

To persist the feature configuration across reboots:

POST request message

- ? "/mchp-velocitysp-system:save-config"
  :

4. Board Configuration Default

The default MUP1 settings can also be set in the board configuration YAML file. This allows different boards to use different defaults at boot time.

Example board configuration:

mchp-velocitysp-system:mup1-config:
  mup1-checksum: crc32
  mup1-features: announce coap dtls ping trace

See Board Configuration for more details on configuring factory defaults.