CMS_OP_WRITE_SOC_CONTROL (0x12) - 4.0 English

Alveo Card Management Solution Subsystem Product Guide (PG348)
Document ID
PG348
Release Date
2023-11-10
Version
4.0 English
Table 1. CMS_OP_WRITE_SOC_CONTROL (0x12) Message Format
MAILBOX Offset 32-bit Word Field Type Field Description
0x00 [0] Host Request Message Message Header

31:24 Opcode (0x12)

23:0 Reserved
0x04 [1] Host Request Message 31:8 Reserved

7:0 SoC Control Opcode

  • 0: Reset SoC - Toggle SoC reset
  • 1: Enable SoC - Clear SoC reset
  • 2: Disable SoC - Hold SoC in reset
0x08 [2] Host Request Message

31:8 Reserved

7:0 Length in Bytes 1
0x0C [3] Host Request Message Magic Number (SoC reset mode only)

31:0 0xb002b002
  1. Length field should be set to 4 to send magic number for SoC reset. In all other modes Length should be set to 0.
Table 2. CMS_OP_WRITE_SOC_CONTROL (0x12) Worked Example - Reset SoC
Host Action Function
Peek 0x28018 Check availability of the mailbox by confirming CONTROL_REG[5] is 0.
Poke 0x29000 0x12000000 Write the request message header to MAILBOX Word 0 (Opcode).

Assumes HOST_MSG_OFFSET_REG = 0x1000.
Poke 0x29004 0x00000000 Set SoC Control Opcode to 0x0 SoC Reset
Poke 0x29008 0x00000004 Set Length to 0x4
Poke 0x2900C 0xb002b002 Set Magic Number 0xb002b002
Poke 0x28018 0x20 Set CONTROL_REG[5] to 1 to indicate a new request message is available
Peek 0x28018 Poll CONTROL_REG bit 5 until ‘0’ is received indicating the CMS response is available.
Peek 0x28304 Confirm no errors in HOST_MSG_ERR_REG.
Table 3. CMS_OP_WRITE_SOC_CONTROL (0x12) Worked Example - Enable SoC
Host Action Function
Peek 0x28018 Check availability of the mailbox by confirming CONTROL_REG[5] is 0.
Poke 0x29000 0x12000000 Write the request message header to MAILBOX Word 0 (Opcode).

Assumes HOST_MSG_OFFSET_REG = 0x1000.
Poke 0x29004 0x00000001 Set SoC Control Opcode to 0x1 SoC Enable
Poke 0x29008 0x00000000 Set Length to 0x0
Poke 0x28018 0x20 Set CONTROL_REG[5] to 1 to indicate a new request message is available
Peek 0x28018 Poll CONTROL_REG bit 5 until ‘0’ is received indicating the CMS response is available.
Peek 0x28304 Confirm no errors in HOST_MSG_ERR_REG.
Table 4. CMS_OP_WRITE_SOC_CONTROL (0x12) Worked Example - Disable SoC
Host Action Function
Peek 0x28018 Check availability of the mailbox by confirming CONTROL_REG[5] is 0.
Poke 0x29000 0x12000000 Write the request message header to MAILBOX Word 0 (Opcode).

Assumes HOST_MSG_OFFSET_REG = 0x1000.
Poke 0x29004 0x00000002 Set SoC Control Opcode to 0x2 SoC Disable
Poke 0x29008 0x00000000 Set Length to 0x0
Poke 0x28018 0x20 Set CONTROL_REG[5] to 1 to indicate a new request message is available
Peek 0x28018 Poll CONTROL_REG bit 5 until ‘0’ is received indicating the CMS response is available.
Peek 0x28304 Confirm no errors in HOST_MSG_ERR_REG.