SetCcTiling (Deprecated)

This API has been deprecated and will be removed in later versions. Do not use this API. Use the SetCcTilingV2 API to set the Tiling address of the communication algorithm.

Applicability

Product	Supported
Atlas A3 training products / Atlas A3 inference products	√
Atlas A2 training products / Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	x
Atlas inference product 's AI Core	x
Atlas inference product 's Vector Core	x
Atlas training products	x

Function

Sets the Tiling address of the HCCL client communication algorithm.

Prototype

      
           __aicore__ inline int32_t SetCcTiling(__gm__ void *ccOpTilingData)

Parameters

**Table 1** API parameters
Parameter	Input/Output	Description
ccOpTilingData	Input	Address of the Mc2CcTiling parameter of the communication algorithm. Mc2CcTiling is computed on the host. For details, see Table 2 Mc2CcTiling parameters. This parameter is passed by the framework to the kernel function for use. For details about the complete example, see 8.13.1.2-Example.

Returns

HCCL_SUCCESS: succeeded
HCCL_FAILED: failed

Restrictions

For the same communication algorithm with the same parameters, this API needs to be called only once before the Prepare API is called. Otherwise, this API needs to be called for multiple times.
Only one ccOpTilingData address can be set for the same communication algorithm. If this API is called repeatedly for the same communication algorithm, the ccOpTilingData address of the communication algorithm will be overwritten.
This API must be used together with the Init API that passes the initTiling address, and the Init API must be called before this API.
If this API is called, the TilingData structure development method must be defined using the standard C++ syntax. For details, see Using the Standard C++ Syntax to Define the Tiling Structure.

Parent topic: HCCL Kernel APIs