Bridge 1.1 API - I3C Common Command Codes

CCC (Common Command Codes)

The CCC (Common Command Codes) provides a set of universal commands supported across multiple devices. The Bridge for Supernova has a few CCCs which can be used to interact with the downstream devices. This section details these CCCs. For more information on this topic see I3C Common Command Codes section.

GETPID

Command Request:

{
  "transaction_id": 9,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "GETPID",
    "address": "08",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": {}
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "9",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_getpid"
  }
}

Command result:

{
  "transaction_id": "9",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_getpid",
    "status": "success",
    "result": {
      "payload": ["0", "0", "0", "0", "64", "65"],
      "payload_size": 6
    }
  }
}

DIRECTSETMRL

Command Request:

{
  "transaction_id": 10,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "DIRECTSETMRL",
    "address": "08",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": { 
      "cccDataBuffer": "10"
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "10",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_direct_setmrl"
  }
}

Command result:

{
  "transaction_id": "10",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_direct_setmrl",
    "status": "success",
    "result": {
      "payload": ["00", "00"],
      "payload_size": 2
    }
  }
}

DIRECTENEC

Command Request:

{
  "transaction_id": 11,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "DIRECTENEC",
    "address": "08",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": { 
      "events": ["ENINT", "ENCR", "ENHJ"]
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "10",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_direct_enec"
  }
}

Command result:

{
  "transaction_id": "10",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_direct_enec",
    "status": "success"
  }
}

Note: For DIRECTDISEC the response's format is very similar, except that the accepted events are ["DISINT", "DISCR", "DISHJ"]. For BROADCASTENEC and BROADCASTDISEC is also similar but address parameter is not required.

SETAASA

Command Request:

{
  "transaction_id": 12,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "SETAASA",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": {
      "staticAddresses": ["08", "09", "0A"]
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "12",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_setaasa"
  }
}

Command result:

{
  "transaction_id": "12",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_setaasa",
    "status": "success"
  }
}

ENTDAA

Command Request:

{
  "transaction_id": 13,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "ENTDAA",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": {
      "targetDeviceTable": {
        "BMM350": {
          "staticAddress": "0x14",
          "dynamicAddress": "0x0C",
          "i3cFeatures": "0x0B",
          "maxIbiPayloadLength": "0xE9",
          "bcr": "0x26",
          "dcr": "0x43",
          "pid": ["0x07", "0x70", "0x10", "0x33", "0x00", "0x00"]
        }
      }
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "13",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_entdaa"
  }
}

Command result:

{
  "transaction_id": "13",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_entdaa",
    "status": "success"
  }
}

Note: When using this command is necessary to previously run i3c_init_bus followed byi3c_reset_bus.

BROADCASTRSTACT

Command Request:

{
  "transaction_id": 14,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "BROADCASTRSTACT",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": {
      "definingByte": "02"
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "14",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_broadcast_rstact"
  }
}

Command result:

{
  "transaction_id": "14",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_broadcast_rstact",
    "status": "success"
  }
}

Note: Similar to DIRECTRSTACT but does not require an address parameter.

DIRECTENDXFER

Command Request:

{
  "transaction_id": 15,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "DIRECTENDXFER",
    "address": "08",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": {
      "definingByte": "AA",
      "data": "20"
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "15",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_direct_endxfer"
  }
}

Command result:

{
  "transaction_id": "15",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_direct_endxfer",
    "status": "success",
    "result": {
      "payload": [0],
      "payload_size": 1
    }
  }
}

Note: Similar to BROADCASTENDXFER, but requires an address parameter.

BROADCASTSETXTIME

Command Request:

{
  "transaction_id": 16,
  "command": "i3c_ccc_send",
  "params": {
    "cccName": "BROADCASTSETXTIME",
    "pushPullClockFrequencyInMHz": "5",
    "openDrainClockFrequencyInKHz": "2500",
    "cccParams": {
      "definingByte": "3F",
      "data": ["DE", "AD", "BE", "EF"]
    }
  }
}

Responses:

Immediate promise:

{
  "transaction_id": "16",
  "status": "success",
  "type": "command_response",
  "is_promise": true,
  "data": {
    "command": "i3c_ccc_broadcast_setxtime"
  }
}

Command result:

{
  "transaction_id": "16",
  "status": "success",
  "type": "command_response",
  "is_promise": false,
  "data": {
    "is_response_to": "i3c_ccc_broadcast_setxtime",
    "status": "success",
    "result": {
      "payload": [0, 0, 0, 0, 0],
      "payload_size": 5
    }
  }
}

Note: Similar to DIRECTSETXTIME, but does not require an address parameter.

Currently Supported CCCs:

Refer to this table for current support status (see Bridge column).

PreviousBridge 1.1 API - Basic I3C Commands NextBridge 1.1 API - I2C Commands

Last updated 26 days ago