xmgethkeyset Kernel Service

Purpose

Retrieves the hardware keyset associated with a cross-memory descriptor.

Syntax

#include <sys/types.h>
#include <sys/kerrno.h>
#include <sys/xmem.h>
#include <sys/skeys.h>

kerrno_t xmgethkeyset (dp, keyset, flags)
struct xmem * dp;
hkeyset_t * hkeyset;
long flags;

Parameters

Table 1. Parameters
Item	Description
`dp`	Specifies a valid cross-memory descriptor.
`hkeyset`	Pointer to returned hardware keyset associated with the cross-memory descriptor.
`flags`	Must be set to zero.

Description

The xmgethkeyset() kernel service can be used to obtain the keyset associated with a cross-memory descriptor.

Kernel-key protection can be enforced on memory regions described by a cross-memory descriptor. The enforcement is done during normal access checking performed by cross-memory services, such as xmemdma() service.

Execution Environment

The xmgethkeyset kernel service can be called from the process or interrupt environment.

Return Values

Table 2. Return Values
Item	Description
`0`	Successful.
`EINVAL_XMGETHKEYSET`	Invalid parameter.