TISCI PM System Reset API Documentation

This document describes the TISCI API for issuing warm reset to a domain.

TISCI_MSG_SYS_RESET

Objective

Request for a software warm reset of a domain.

Usage

Message Type	Normal
Secure Queue Only?	No

User can use this API to issue software warm reset of a domain. The domain definition may vary from SoC to SoC. Depending on the SoC, certain domain reset could be defined to be equivalent to a system-wide reset. The reset brings the device or part of the device to a known state after events such as power-up, hardware request, or software request. The domain reset can be used for error handling and recovery.

To maintain backward compatibility, when a user leaves the domain parameter empty, the API would process the message with the DOMGRP_COMPATIBILITY as the domain value.

After calling the TISCI_MSG_SYS_RESET API, the chosen domain will be deinitialized. The user is responsible for reconfiguring the devices in the chosen domain by resending the board configuration for baseport, power management, resource management, and security management. If the chosen domain reset would lead to system-wide reset, then no additional board configuration calls are necessary.

Macros Used in this Document

TISCI Message ID

TISCI_MSG_SYS_RESET          (0x0005U)

Message Data Structures

struct tisci_msg_sys_reset_req

Request for TISCI_MSG_SYS_RESET.

Parameter	Type	Description
hdr	struct tisci_header	TISCI header to provide ACK/NAK flags to the host.
domain	domgrp_t	Domain to be reset.

To maintain backward compatibility, when a user does not pass the domain argument, it would perform the SoC’s default reset behavior.

struct tisci_msg_sys_reset_resp

Empty response for TISCI_MSG_SYS_RESET.

Parameter	Type	Description
hdr	struct tisci_header	TISCI header.

Although this message is essentially empty and contains only a header a full data structure is created for consistency in implementation.