rtos_i2s_driver_rpc

Functions
void	rtos_i2s_rpc_client_init (rtos_i2s_t *i2s_ctx, rtos_driver_rpc_t *rpc_config, rtos_intertile_t *host_intertile_ctx)
void	rtos_i2s_rpc_host_init (rtos_i2s_t *i2s_ctx, rtos_driver_rpc_t *rpc_config, rtos_intertile_t *client_intertile_ctx[], size_t remote_client_count)
void	rtos_i2s_rpc_config (rtos_i2s_t *i2s_ctx, unsigned intertile_port, unsigned host_task_priority)

Detailed Description

The functions for setting up RPC with an RTOS I2S driver instance.

Function Documentation

rtos_i2s_rpc_client_init()

void rtos_i2s_rpc_client_init	(	rtos_i2s_t *	i2s_ctx,
		rtos_driver_rpc_t *	rpc_config,
		rtos_intertile_t *	host_intertile_ctx
	)

Initializes an RTOS I2S driver instance on a client tile. This allows a tile that does not own the actual driver instance to use a driver instance on another tile. This will be called instead of on of the RTOS I2S init functions. The host tile that owns the actual instance must simultaneously call rtos_i2s_rpc_host_init().

Parameters

i2s_ctx	A pointer to the I2S driver instance to initialize.
rpc_config	A pointer to an RPC config struct. This must have the same scope as i2s_ctx.
host_intertile_ctx	A pointer to the intertile driver instance to use for performing the communication between the client and host tiles. This must have the same scope as i2s_ctx.

rtos_i2s_rpc_config()

void rtos_i2s_rpc_config	(	rtos_i2s_t *	i2s_ctx,
		unsigned	intertile_port,
		unsigned	host_task_priority
	)

Configures the RPC for a I2S driver instance. This must be called by both the host tile and all client tiles.

On the client tiles this must be called after calling rtos_i2s_rpc_client_init(). After calling this, the client tile may immediately begin to call the core I2S functions on this driver instance. It does not need to wait for the host to call rtos_i2s_start().

On the host tile this must be called both after calling rtos_i2s_rpc_host_init() and before calling rtos_i2s_start().

Parameters

i2s_ctx	A pointer to the I2S driver instance to configure the RPC for.
intertile_port	The port number on the intertile channel to use for transferring the RPC requests and responses for this driver instance. This port must not be shared by any other functions. The port must be the same for the host and all its clients.
host_task_priority	The priority to use for the task on the host tile that handles RPC requests from the clients.

rtos_i2s_rpc_host_init()

void rtos_i2s_rpc_host_init	(	rtos_i2s_t *	i2s_ctx,
		rtos_driver_rpc_t *	rpc_config,
		rtos_intertile_t *	client_intertile_ctx[],
		size_t	remote_client_count
	)

Performs additional initialization on a I2S driver instance to allow client tiles to use the I2S driver instance. Each client tile that will use this instance must simultaneously call rtos_i2s_rpc_client_init().

Parameters

i2s_ctx	A pointer to the I2S driver instance to share with clients.
rpc_config	A pointer to an RPC config struct. This must have the same scope as i2s_ctx.
client_intertile_ctx	An array of pointers to the intertile driver instances to use for performing the communication between the host tile and each client tile. This must have the same scope as i2s_ctx.
remote_client_count	The number of client tiles to share this driver instance with.