hdcp22_cipher
Xilinx SDK Drivers API Documentation
Hdcp22_cipher_v1_1

Data Structures

struct  XHdcp22_Cipher_Config
 This typedef contains configuration information for the HDCP22 Cipher core. More...
 
struct  XHdcp22_Cipher
 The XHdcp22 Cipher driver instance data. More...
 

Macros

#define XHDCP22_CIPHER_H
 < Prevent circular inclusions by using protection macros More...
 
#define XHdcp22Cipher_Enable(InstancePtr)
 This macro enables the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_Disable(InstancePtr)
 This macro disables the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_IsEnabled(InstancePtr)
 This macro returns the encrypted enabled state of the HDCP22 Cipher core instance. More...
 
#define XHdcp22Cipher_SetTxMode(InstancePtr)
 This macro sets the HDCP operation mode for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_SetRxMode(InstancePtr)
 This macro sets the HDCP RX operation mode for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_EnableTxEncryption(InstancePtr)
 This macro enables HDCP TX encryption for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_DisableTxEncryption(InstancePtr)
 This macro disables HDCP TX encryption for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_IsTxEncryptionEnabled(InstancePtr)
 This macro returns the encrypted enabled state of HDCP TX encryption for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_IsEncrypted(InstancePtr)
 This macro returns the encrypted state for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_Noise(InstancePtr, Set)
 This macro enables or disables noise output for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_Blank(InstancePtr, Set)
 This macro enables or disables blank screen for the HDCP22 Cipher peripheral. More...
 
#define XHdcp22Cipher_GetVersion(InstancePtr)   XHdcp22Cipher_ReadReg((InstancePtr)->Config.BaseAddress, XHDCP22_CIPHER_VER_VERSION_OFFSET)
 This macro reads the version for the HDCP22 Cipher peripheral. More...
 
#define XHDCP22_CIPHER_HW_H
 < Prevent circular inclusions by using protection macros More...
 
#define XHDCP22_CIPHER_VER_ID_OFFSET   ((XHDCP22_CIPHER_VER_BASE)+(0*4))
 VER Identification register * register offset. More...
 
#define XHDCP22_CIPHER_VER_VERSION_OFFSET   ((XHDCP22_CIPHER_VER_BASE)+(1*4))
 VER Version register * offset. More...
 
#define XHDCP22_CIPHER_REG_CTRL_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(0*4))
 Control register * register offset. More...
 
#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(1*4))
 Control set register * offset. More...
 
#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(2*4))
 Control clear register * offset. More...
 
#define XHDCP22_CIPHER_REG_STA_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(3*4))
 Status register * offset. More...
 
#define XHDCP22_CIPHER_REG_KS_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(4*4))
 Ks register 1 * offset. More...
 
#define XHDCP22_CIPHER_REG_KS_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(5*4))
 Ks register 2 * offset. More...
 
#define XHDCP22_CIPHER_REG_KS_3_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(6*4))
 Ks register 3 * offset. More...
 
#define XHDCP22_CIPHER_REG_KS_4_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(7*4))
 Ks register 4 * offset. More...
 
#define XHDCP22_CIPHER_REG_LC128_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(8*4))
 Lc128 register 1 * offset. More...
 
#define XHDCP22_CIPHER_REG_LC128_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(9*4))
 Lc128 register 2 * offset. More...
 
#define XHDCP22_CIPHER_REG_LC128_3_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(10*4))
 Lc128 register 3 * offset. More...
 
#define XHDCP22_CIPHER_REG_LC128_4_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(11*4))
 Lc128 register 4 * offset. More...
 
#define XHDCP22_CIPHER_REG_RIV_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(12*4))
 Riv register 1 * offset. More...
 
#define XHDCP22_CIPHER_REG_RIV_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(13*4))
 Riv register 2 * offset. More...
 
#define XHDCP22_CIPHER_REG_INPUTCTR_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(14*4))
 InputCtr register 1 * offset. More...
 
#define XHDCP22_CIPHER_REG_INPUTCTR_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(15*4))
 InputCtr register 2 * offset. More...
 
#define XHDCP22_CIPHER_REG_CTRL_RUN_MASK   (1<<0)
 Control register Run mask. More...
 
#define XHDCP22_CIPHER_REG_CTRL_IE_MASK   (1<<1)
 Control register Interrupt Enable mask. More...
 
#define XHDCP22_CIPHER_REG_CTRL_MODE_MASK   (1<<2)
 Control register Mode mask. More...
 
#define XHDCP22_CIPHER_REG_CTRL_ENCRYPT_MASK   (1<<3)
 Control register Encrypt mask. More...
 
#define XHDCP22_CIPHER_REG_CTRL_BLANK_MASK   (1<<4)
 Control register blank mask. More...
 
#define XHDCP22_CIPHER_REG_CTRL_NOISE_MASK   (1<<5)
 Control register noise mask. More...
 
#define XHDCP22_CIPHER_REG_STA_IRQ_MASK   (1<<0)
 Status register interrupt mask. More...
 
#define XHDCP22_CIPHER_REG_STA_EVT_MASK   (1<<1)
 Status register event mask. More...
 
#define XHDCP22_CIPHER_REG_STA_ENCRYPTED_MASK   (1<<2)
 Status register encrypted mask. More...
 
#define XHDCP22_CIPHER_SHIFT_16   16
 16 shift value More...
 
#define XHDCP22_CIPHER_MASK_16   0xFFFF
 16 bit mask value More...
 
#define XHDCP22_CIPHER_VER_ID   0x2200
 Version ID. More...
 

Functions

int XHdcp22Cipher_CfgInitialize (XHdcp22_Cipher *InstancePtr, XHdcp22_Cipher_Config *CfgPtr, UINTPTR EffectiveAddr)
 This function initializes the HDCP22 Cipher core. More...
 
void XHdcp22Cipher_SetKs (XHdcp22_Cipher *InstancePtr, const u8 *KsPtr, u16 Length)
 This function sets the Ks key in the HDCP22 Cipher core. More...
 
void XHdcp22Cipher_SetLc128 (XHdcp22_Cipher *InstancePtr, const u8 *Lc128Ptr, u16 Length)
 This function sets the Lc128 key in the HDCP22 Cipher core. More...
 
void XHdcp22Cipher_SetRiv (XHdcp22_Cipher *InstancePtr, const u8 *RivPtr, u16 Length)
 This function sets the Riv key in the HDCP22 Cipher core. More...
 
XHdcp22_Cipher_ConfigXHdcp22Cipher_LookupConfig (u16 DeviceId)
 This function returns a reference to an XHdcp22_Cipher_Config structure based on the core id, DeviceId. More...
 
int XHdcp22Cipher_SelfTest (XHdcp22_Cipher *InstancePtr)
 This function reads ID of the peripheral. More...
 

Register access macro definition

#define XHdcp22Cipher_In32   Xil_In32
 Input Operations. More...
 
#define XHdcp22Cipher_Out32   Xil_Out32
 Output Operations. More...
 
#define XHdcp22Cipher_ReadReg(BaseAddress, RegOffset)   XHdcp22Cipher_In32((BaseAddress) + ((u32)RegOffset))
 This macro reads a value from a HDCP22 Cipher register. More...
 
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)   XHdcp22Cipher_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))
 This macro writes a value to a HDCP22 Cipher register. More...
 
#define XHdcp22Cipher_GetStatusReg(BaseAddress)   XHdcp22Cipher_ReadReg(BaseAddress, XHDCP22_CIPHER_REG_STA_OFFSET)
 This macro reads the status register from the HDCP22 Cipher. More...
 
#define XHdcp22Cipher_GetControlReg(BaseAddress)   XHdcp22Cipher_ReadReg(BaseAddress, XHDCP22_CIPHER_REG_CTRL_OFFSET)
 This macro reads the control register from the HDCP22 Cipher. More...
 

Macro Definition Documentation

◆ XHDCP22_CIPHER_H

#define XHDCP22_CIPHER_H

#include <xhdcp22_cipher.h>

< Prevent circular inclusions by using protection macros

◆ XHDCP22_CIPHER_HW_H

#define XHDCP22_CIPHER_HW_H

#include <xhdcp22_cipher_hw.h>

< Prevent circular inclusions by using protection macros

◆ XHDCP22_CIPHER_MASK_16

#define XHDCP22_CIPHER_MASK_16   0xFFFF

#include <xhdcp22_cipher_hw.h>

16 bit mask value

Referenced by XHdcp22Cipher_CfgInitialize(), and XHdcp22Cipher_SelfTest().

◆ XHDCP22_CIPHER_REG_CTRL_BLANK_MASK

#define XHDCP22_CIPHER_REG_CTRL_BLANK_MASK   (1<<4)

#include <xhdcp22_cipher_hw.h>

Control register blank mask.

◆ XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET

#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(2*4))

#include <xhdcp22_cipher_hw.h>

Control clear register * offset.

◆ XHDCP22_CIPHER_REG_CTRL_ENCRYPT_MASK

#define XHDCP22_CIPHER_REG_CTRL_ENCRYPT_MASK   (1<<3)

#include <xhdcp22_cipher_hw.h>

Control register Encrypt mask.

◆ XHDCP22_CIPHER_REG_CTRL_IE_MASK

#define XHDCP22_CIPHER_REG_CTRL_IE_MASK   (1<<1)

#include <xhdcp22_cipher_hw.h>

Control register Interrupt Enable mask.

Reserved for future use.

◆ XHDCP22_CIPHER_REG_CTRL_MODE_MASK

#define XHDCP22_CIPHER_REG_CTRL_MODE_MASK   (1<<2)

#include <xhdcp22_cipher_hw.h>

Control register Mode mask.

◆ XHDCP22_CIPHER_REG_CTRL_NOISE_MASK

#define XHDCP22_CIPHER_REG_CTRL_NOISE_MASK   (1<<5)

#include <xhdcp22_cipher_hw.h>

Control register noise mask.

◆ XHDCP22_CIPHER_REG_CTRL_OFFSET

#define XHDCP22_CIPHER_REG_CTRL_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(0*4))

#include <xhdcp22_cipher_hw.h>

Control register * register offset.

◆ XHDCP22_CIPHER_REG_CTRL_RUN_MASK

#define XHDCP22_CIPHER_REG_CTRL_RUN_MASK   (1<<0)

#include <xhdcp22_cipher_hw.h>

Control register Run mask.

◆ XHDCP22_CIPHER_REG_CTRL_SET_OFFSET

#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(1*4))

#include <xhdcp22_cipher_hw.h>

Control set register * offset.

◆ XHDCP22_CIPHER_REG_INPUTCTR_1_OFFSET

#define XHDCP22_CIPHER_REG_INPUTCTR_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(14*4))

#include <xhdcp22_cipher_hw.h>

InputCtr register 1 * offset.

◆ XHDCP22_CIPHER_REG_INPUTCTR_2_OFFSET

#define XHDCP22_CIPHER_REG_INPUTCTR_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(15*4))

#include <xhdcp22_cipher_hw.h>

InputCtr register 2 * offset.

◆ XHDCP22_CIPHER_REG_KS_1_OFFSET

#define XHDCP22_CIPHER_REG_KS_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(4*4))

#include <xhdcp22_cipher_hw.h>

Ks register 1 * offset.

Referenced by XHdcp22Cipher_SetKs().

◆ XHDCP22_CIPHER_REG_KS_2_OFFSET

#define XHDCP22_CIPHER_REG_KS_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(5*4))

#include <xhdcp22_cipher_hw.h>

Ks register 2 * offset.

◆ XHDCP22_CIPHER_REG_KS_3_OFFSET

#define XHDCP22_CIPHER_REG_KS_3_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(6*4))

#include <xhdcp22_cipher_hw.h>

Ks register 3 * offset.

◆ XHDCP22_CIPHER_REG_KS_4_OFFSET

#define XHDCP22_CIPHER_REG_KS_4_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(7*4))

#include <xhdcp22_cipher_hw.h>

Ks register 4 * offset.

◆ XHDCP22_CIPHER_REG_LC128_1_OFFSET

#define XHDCP22_CIPHER_REG_LC128_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(8*4))

#include <xhdcp22_cipher_hw.h>

Lc128 register 1 * offset.

Referenced by XHdcp22Cipher_SetLc128().

◆ XHDCP22_CIPHER_REG_LC128_2_OFFSET

#define XHDCP22_CIPHER_REG_LC128_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(9*4))

#include <xhdcp22_cipher_hw.h>

Lc128 register 2 * offset.

◆ XHDCP22_CIPHER_REG_LC128_3_OFFSET

#define XHDCP22_CIPHER_REG_LC128_3_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(10*4))

#include <xhdcp22_cipher_hw.h>

Lc128 register 3 * offset.

◆ XHDCP22_CIPHER_REG_LC128_4_OFFSET

#define XHDCP22_CIPHER_REG_LC128_4_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(11*4))

#include <xhdcp22_cipher_hw.h>

Lc128 register 4 * offset.

◆ XHDCP22_CIPHER_REG_RIV_1_OFFSET

#define XHDCP22_CIPHER_REG_RIV_1_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(12*4))

#include <xhdcp22_cipher_hw.h>

Riv register 1 * offset.

Referenced by XHdcp22Cipher_SetRiv().

◆ XHDCP22_CIPHER_REG_RIV_2_OFFSET

#define XHDCP22_CIPHER_REG_RIV_2_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(13*4))

#include <xhdcp22_cipher_hw.h>

Riv register 2 * offset.

◆ XHDCP22_CIPHER_REG_STA_ENCRYPTED_MASK

#define XHDCP22_CIPHER_REG_STA_ENCRYPTED_MASK   (1<<2)

#include <xhdcp22_cipher_hw.h>

Status register encrypted mask.

◆ XHDCP22_CIPHER_REG_STA_EVT_MASK

#define XHDCP22_CIPHER_REG_STA_EVT_MASK   (1<<1)

#include <xhdcp22_cipher_hw.h>

Status register event mask.

Reserved for future use.

◆ XHDCP22_CIPHER_REG_STA_IRQ_MASK

#define XHDCP22_CIPHER_REG_STA_IRQ_MASK   (1<<0)

#include <xhdcp22_cipher_hw.h>

Status register interrupt mask.

Reserved for future use.

◆ XHDCP22_CIPHER_REG_STA_OFFSET

#define XHDCP22_CIPHER_REG_STA_OFFSET   ((XHDCP22_CIPHER_REG_BASE)+(3*4))

#include <xhdcp22_cipher_hw.h>

Status register * offset.

◆ XHDCP22_CIPHER_SHIFT_16

#define XHDCP22_CIPHER_SHIFT_16   16

#include <xhdcp22_cipher_hw.h>

16 shift value

Referenced by XHdcp22Cipher_CfgInitialize(), and XHdcp22Cipher_SelfTest().

◆ XHDCP22_CIPHER_VER_ID

#define XHDCP22_CIPHER_VER_ID   0x2200

◆ XHDCP22_CIPHER_VER_ID_OFFSET

#define XHDCP22_CIPHER_VER_ID_OFFSET   ((XHDCP22_CIPHER_VER_BASE)+(0*4))

#include <xhdcp22_cipher_hw.h>

VER Identification register * register offset.

Referenced by XHdcp22Cipher_CfgInitialize(), and XHdcp22Cipher_SelfTest().

◆ XHDCP22_CIPHER_VER_VERSION_OFFSET

#define XHDCP22_CIPHER_VER_VERSION_OFFSET   ((XHDCP22_CIPHER_VER_BASE)+(1*4))

#include <xhdcp22_cipher_hw.h>

VER Version register * offset.

◆ XHdcp22Cipher_Blank

#define XHdcp22Cipher_Blank (   InstancePtr,
  Set 
)

#include <xhdcp22_cipher.h>

Value:
{ \
if (Set) { \
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, (XHDCP22_CIPHER_REG_CTRL_SET_OFFSET), (XHDCP22_CIPHER_REG_CTRL_BLANK_MASK)); \
} \
else { \
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, (XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET), (XHDCP22_CIPHER_REG_CTRL_BLANK_MASK)); \
} \
}
#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET
Control set register * offset.
Definition: xhdcp22_cipher_hw.h:79
#define XHDCP22_CIPHER_REG_CTRL_BLANK_MASK
Control register blank mask.
Definition: xhdcp22_cipher_hw.h:119
#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET
Control clear register * offset.
Definition: xhdcp22_cipher_hw.h:81

This macro enables or disables blank screen for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Setspecifies TRUE/FALSE either to enable/disable blank screen.
Returns
none.
Note
C-style signature: void XHdcp22Cipher_Blank(u32 BaseAddress, u8 Set)

◆ XHdcp22Cipher_Disable

#define XHdcp22Cipher_Disable (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, \
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)
This macro writes a value to a HDCP22 Cipher register.
Definition: xhdcp22_cipher_hw.h:187
#define XHDCP22_CIPHER_REG_CTRL_RUN_MASK
Control register Run mask.
Definition: xhdcp22_cipher_hw.h:111
#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET
Control clear register * offset.
Definition: xhdcp22_cipher_hw.h:81

This macro disables the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_Disable(u32 BaseAddress)

◆ XHdcp22Cipher_DisableTxEncryption

#define XHdcp22Cipher_DisableTxEncryption (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, \
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)
This macro writes a value to a HDCP22 Cipher register.
Definition: xhdcp22_cipher_hw.h:187
#define XHDCP22_CIPHER_REG_CTRL_ENCRYPT_MASK
Control register Encrypt mask.
Definition: xhdcp22_cipher_hw.h:117
#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET
Control clear register * offset.
Definition: xhdcp22_cipher_hw.h:81

This macro disables HDCP TX encryption for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_DisableTxEncryption(u32 BaseAddress)

◆ XHdcp22Cipher_Enable

#define XHdcp22Cipher_Enable (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, \
#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET
Control set register * offset.
Definition: xhdcp22_cipher_hw.h:79
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)
This macro writes a value to a HDCP22 Cipher register.
Definition: xhdcp22_cipher_hw.h:187
#define XHDCP22_CIPHER_REG_CTRL_RUN_MASK
Control register Run mask.
Definition: xhdcp22_cipher_hw.h:111

This macro enables the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_Enable(u32 BaseAddress)

◆ XHdcp22Cipher_EnableTxEncryption

#define XHdcp22Cipher_EnableTxEncryption (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, \
#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET
Control set register * offset.
Definition: xhdcp22_cipher_hw.h:79
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)
This macro writes a value to a HDCP22 Cipher register.
Definition: xhdcp22_cipher_hw.h:187
#define XHDCP22_CIPHER_REG_CTRL_ENCRYPT_MASK
Control register Encrypt mask.
Definition: xhdcp22_cipher_hw.h:117

This macro enables HDCP TX encryption for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_EnableTxEncryption(u32 BaseAddress)

◆ XHdcp22Cipher_GetControlReg

#define XHdcp22Cipher_GetControlReg (   BaseAddress)    XHdcp22Cipher_ReadReg(BaseAddress, XHDCP22_CIPHER_REG_CTRL_OFFSET)

#include <xhdcp22_cipher_hw.h>

This macro reads the control register from the HDCP22 Cipher.

Parameters
BaseAddressis the base address of the HDCP22 Cipher core instance.
Returns
A 32-bit value representing the contents of the control register.
Note
C-style signature: u32 XHdcp22Cipher_GetStatusReg(u32 BaseAddress)

◆ XHdcp22Cipher_GetStatusReg

#define XHdcp22Cipher_GetStatusReg (   BaseAddress)    XHdcp22Cipher_ReadReg(BaseAddress, XHDCP22_CIPHER_REG_STA_OFFSET)

#include <xhdcp22_cipher_hw.h>

This macro reads the status register from the HDCP22 Cipher.

Parameters
IBaseAddressis the base address of the HDCP22 Cipher core instance.
Returns
A 32-bit value representing the contents of the status register.
Note
C-style signature: u32 XHdcp22Cipher_GetStatusReg(u32 BaseAddress)

◆ XHdcp22Cipher_GetVersion

#define XHdcp22Cipher_GetVersion (   InstancePtr)    XHdcp22Cipher_ReadReg((InstancePtr)->Config.BaseAddress, XHDCP22_CIPHER_VER_VERSION_OFFSET)

#include <xhdcp22_cipher.h>

This macro reads the version for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
version.
Note
C-style signature: void XHdcp22Cipher_GetVersion(u32 BaseAddress)

◆ XHdcp22Cipher_In32

#define XHdcp22Cipher_In32   Xil_In32

#include <xhdcp22_cipher_hw.h>

Input Operations.

◆ XHdcp22Cipher_IsEnabled

#define XHdcp22Cipher_IsEnabled (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
((XHdcp22Cipher_GetControlReg((InstancePtr)->Config.BaseAddress)\
#define XHdcp22Cipher_GetControlReg(BaseAddress)
This macro reads the control register from the HDCP22 Cipher.
Definition: xhdcp22_cipher_hw.h:218
#define XHDCP22_CIPHER_REG_CTRL_RUN_MASK
Control register Run mask.
Definition: xhdcp22_cipher_hw.h:111

This macro returns the encrypted enabled state of the HDCP22 Cipher core instance.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
TRUE if HDCP22 cipher is enabled, FALSE otherwise.
Note
C-style signature: u32 XHdcp22Cipher_IsEnabled(u32 BaseAddress)

◆ XHdcp22Cipher_IsEncrypted

#define XHdcp22Cipher_IsEncrypted (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
((XHdcp22Cipher_GetStatusReg((InstancePtr)->Config.BaseAddress) \
#define XHDCP22_CIPHER_REG_STA_ENCRYPTED_MASK
Status register encrypted mask.
Definition: xhdcp22_cipher_hw.h:129
#define XHdcp22Cipher_GetStatusReg(BaseAddress)
This macro reads the status register from the HDCP22 Cipher.
Definition: xhdcp22_cipher_hw.h:202

This macro returns the encrypted state for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
TRUE if the frame is encrypted, FALSE otherwise.
Note
C-style signature: void XHdcp22Cipher_DisableTxEncryption(u32 BaseAddress)

◆ XHdcp22Cipher_IsTxEncryptionEnabled

#define XHdcp22Cipher_IsTxEncryptionEnabled (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
((XHdcp22Cipher_GetControlReg((InstancePtr)->Config.BaseAddress)\
#define XHdcp22Cipher_GetControlReg(BaseAddress)
This macro reads the control register from the HDCP22 Cipher.
Definition: xhdcp22_cipher_hw.h:218
#define XHDCP22_CIPHER_REG_CTRL_ENCRYPT_MASK
Control register Encrypt mask.
Definition: xhdcp22_cipher_hw.h:117

This macro returns the encrypted enabled state of HDCP TX encryption for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
TRUE if HDCP22 TX encryption is enabled, FALSE otherwise.
Note
C-style signature: u32 XHdcp22Cipher_IsTxEncryptionEnabled(u32 BaseAddress)

◆ XHdcp22Cipher_Noise

#define XHdcp22Cipher_Noise (   InstancePtr,
  Set 
)

#include <xhdcp22_cipher.h>

Value:
{ \
if (Set) { \
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, (XHDCP22_CIPHER_REG_CTRL_SET_OFFSET), (XHDCP22_CIPHER_REG_CTRL_NOISE_MASK)); \
} \
else { \
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, (XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET), (XHDCP22_CIPHER_REG_CTRL_NOISE_MASK)); \
} \
}
#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET
Control set register * offset.
Definition: xhdcp22_cipher_hw.h:79
#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET
Control clear register * offset.
Definition: xhdcp22_cipher_hw.h:81
#define XHDCP22_CIPHER_REG_CTRL_NOISE_MASK
Control register noise mask.
Definition: xhdcp22_cipher_hw.h:121

This macro enables or disables noise output for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Setspecifies TRUE/FALSE either to enable/disable noise output.
Returns
none.
Note
C-style signature: void XHdcp22Cipher_Noise(u32 BaseAddress, u8 Set)

◆ XHdcp22Cipher_Out32

#define XHdcp22Cipher_Out32   Xil_Out32

#include <xhdcp22_cipher_hw.h>

Output Operations.

◆ XHdcp22Cipher_ReadReg

#define XHdcp22Cipher_ReadReg (   BaseAddress,
  RegOffset 
)    XHdcp22Cipher_In32((BaseAddress) + ((u32)RegOffset))

#include <xhdcp22_cipher_hw.h>

This macro reads a value from a HDCP22 Cipher register.

A 32 bit read is performed. If the component is implemented in a smaller width, only the least significant data is read from the register. The most significant data will be read as 0.

Parameters
BaseAddressis the base address of the HDCP22 Cipher core instance.
RegOffsetis the register offset of the register (defined at the top of this file).
Returns
The 32-bit value of the register.
Note
C-style signature: u32 XHdcp22Cipher_ReadReg(u32 BaseAddress, u32 RegOffset)

Referenced by XHdcp22Cipher_CfgInitialize(), and XHdcp22Cipher_SelfTest().

◆ XHdcp22Cipher_SetRxMode

#define XHdcp22Cipher_SetRxMode (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, \
#define XHDCP22_CIPHER_REG_CTRL_SET_OFFSET
Control set register * offset.
Definition: xhdcp22_cipher_hw.h:79
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)
This macro writes a value to a HDCP22 Cipher register.
Definition: xhdcp22_cipher_hw.h:187
#define XHDCP22_CIPHER_REG_CTRL_MODE_MASK
Control register Mode mask.
Definition: xhdcp22_cipher_hw.h:115

This macro sets the HDCP RX operation mode for the HDCP22 Cipher peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_SetRxMode(u32 BaseAddress)

◆ XHdcp22Cipher_SetTxMode

#define XHdcp22Cipher_SetTxMode (   InstancePtr)

#include <xhdcp22_cipher.h>

Value:
XHdcp22Cipher_WriteReg((InstancePtr)->Config.BaseAddress, \
#define XHdcp22Cipher_WriteReg(BaseAddress, RegOffset, Data)
This macro writes a value to a HDCP22 Cipher register.
Definition: xhdcp22_cipher_hw.h:187
#define XHDCP22_CIPHER_REG_CTRL_CLR_OFFSET
Control clear register * offset.
Definition: xhdcp22_cipher_hw.h:81
#define XHDCP22_CIPHER_REG_CTRL_MODE_MASK
Control register Mode mask.
Definition: xhdcp22_cipher_hw.h:115

This macro sets the HDCP operation mode for the HDCP22 Cipher peripheral.

The mode

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_SetTxMode(u32 BaseAddress)

◆ XHdcp22Cipher_WriteReg

#define XHdcp22Cipher_WriteReg (   BaseAddress,
  RegOffset,
  Data 
)    XHdcp22Cipher_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))

#include <xhdcp22_cipher_hw.h>

This macro writes a value to a HDCP22 Cipher register.

A 32 bit write is performed. If the component is implemented in a smaller width, only the least significant data is written.

Parameters
BaseAddressis the base address of the HDCP22 Cipher core instance.
RegOffsetis the register offset of the register (defined at the top of this file) to be written.
Datais the 32-bit value to write into the register.
Returns
None.
Note
C-style signature: void XHdcp22Cipher_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Referenced by XHdcp22Cipher_SetKs(), XHdcp22Cipher_SetLc128(), and XHdcp22Cipher_SetRiv().

Function Documentation

◆ XHdcp22Cipher_CfgInitialize()

int XHdcp22Cipher_CfgInitialize ( XHdcp22_Cipher InstancePtr,
XHdcp22_Cipher_Config CfgPtr,
UINTPTR  EffectiveAddr 
)

#include <xhdcp22_cipher.c>

This function initializes the HDCP22 Cipher core.

This function must be called prior to using the HDCP22 Cipher core. Initialization of the HDCP22 Cipher includes setting up the instance data, and ensuring the hardware is in a quiescent state.

Parameters
InstancePtris a pointer to the XHdcp22_Cipher core instance.
CfgPtrpoints to the configuration structure associated with the HDCP22 Cipher core core.
EffectiveAddris the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.
Returns
  • XST_SUCCESS if XHdcp22Cipher_CfgInitialize was successful.
  • XST_FAILURE if HDCP22 Cipher ID mismatched.
Note
None.

References XHdcp22_Cipher_Config::BaseAddress, XHdcp22_Cipher::Config, XHdcp22_Cipher::IsReady, XHDCP22_CIPHER_MASK_16, XHDCP22_CIPHER_SHIFT_16, XHDCP22_CIPHER_VER_ID, XHDCP22_CIPHER_VER_ID_OFFSET, and XHdcp22Cipher_ReadReg.

◆ XHdcp22Cipher_LookupConfig()

XHdcp22_Cipher_Config * XHdcp22Cipher_LookupConfig ( u16  DeviceId)

#include <xhdcp22_cipher.h>

This function returns a reference to an XHdcp22_Cipher_Config structure based on the core id, DeviceId.

The return value will refer to an entry in the device configuration table defined in the xhdcp22_cipher_g.c file.

Parameters
DeviceIdis the unique core ID of the XHDCP22 Cipher core for the lookup operation.
Returns
XHdcp22Cipher_LookupConfig returns a reference to a config record in the configuration table (in xhdcp22_cipher_g.c) corresponding to DeviceId, or NULL if no match is found.
Note
None.

◆ XHdcp22Cipher_SelfTest()

int XHdcp22Cipher_SelfTest ( XHdcp22_Cipher InstancePtr)

#include <xhdcp22_cipher_selftest.c>

This function reads ID of the peripheral.

Parameters
InstancePtris a pointer to the HDCP22 Cipher core instance.
Returns
  • XST_SUCCESS if ID was matched.
  • XST_FAILURE if ID was mismatched.
Note
None.

References XHdcp22_Cipher_Config::BaseAddress, XHdcp22_Cipher::Config, XHDCP22_CIPHER_MASK_16, XHDCP22_CIPHER_SHIFT_16, XHDCP22_CIPHER_VER_ID, XHDCP22_CIPHER_VER_ID_OFFSET, and XHdcp22Cipher_ReadReg.

◆ XHdcp22Cipher_SetKs()

void XHdcp22Cipher_SetKs ( XHdcp22_Cipher InstancePtr,
const u8 *  KsPtr,
u16  Length 
)

#include <xhdcp22_cipher.c>

This function sets the Ks key in the HDCP22 Cipher core.

Parameters
BaseAddressis the base address of the HDCP22 Cipher core instance.
KsPtris a pointer to the Ks key.
Lengthindicates the number of bytes.
Returns
None.
Note
The Ks should be in big endian notation.

References XHdcp22_Cipher_Config::BaseAddress, XHdcp22_Cipher::Config, XHDCP22_CIPHER_REG_KS_1_OFFSET, and XHdcp22Cipher_WriteReg.

◆ XHdcp22Cipher_SetLc128()

void XHdcp22Cipher_SetLc128 ( XHdcp22_Cipher InstancePtr,
const u8 *  Lc128Ptr,
u16  Length 
)

#include <xhdcp22_cipher.c>

This function sets the Lc128 key in the HDCP22 Cipher core.

Parameters
BaseAddressis the base address of the HDCP22 Cipher core instance.
Lc128Ptris a pointer to the LC128 key.
Lengthindicates the number of bytes.
Returns
None.
Note
The Lc128 should be in big endian notation.

References XHdcp22_Cipher_Config::BaseAddress, XHdcp22_Cipher::Config, XHDCP22_CIPHER_REG_LC128_1_OFFSET, and XHdcp22Cipher_WriteReg.

◆ XHdcp22Cipher_SetRiv()

void XHdcp22Cipher_SetRiv ( XHdcp22_Cipher InstancePtr,
const u8 *  RivPtr,
u16  Length 
)

#include <xhdcp22_cipher.c>

This function sets the Riv key in the HDCP22 Cipher core.

Parameters
BaseAddressis the base address of the HDCP22 Cipher core instance.
RivPtris a pointer to the Riv key.
Lengthindicates the number of bytes.
Returns
None.
Note
The Riv should be in big endian notation.

References XHdcp22_Cipher_Config::BaseAddress, XHdcp22_Cipher::Config, XHDCP22_CIPHER_REG_RIV_1_OFFSET, and XHdcp22Cipher_WriteReg.