Introduction

Here is the list of APIs used for HDSL Encoder communication protocol

Data Structures
struct	HDSL_Interface

struct	HDSL_Config

Functions
void	hdsl_enable_load_share_mode (void *gPru_cfg, uint32_t PRU_SLICE)
	enable load share mode for multi-channel HDSL More...

HDSL_Handle	HDSL_open (PRUICSS_Handle icssgHandle, uint32_t icssCore, uint8_t PRU_mode)
	Open HDSL handle for the specified core (interrupt mapping should already be completed) More...

void	HDSL_iep_init (HDSL_Handle hdslHandle)
	Initialize IEP and Use OCP as IEP CLK src. More...

int	HDSL_enable_sync_signal (uint8_t ES, uint32_t period)
	Enable IEP *Enable SYNC0 and program pulse width Enable cyclic mod Program CMP1 TSR configuration More...

uint64_t	HDSL_get_pos (HDSL_Handle hdslHandle, int position_id)
	Calculate fast position,safe position1,safe position2. More...

uint8_t	HDSL_get_qm (HDSL_Handle hdslHandle)
	Getting quality monitoring value. More...

uint16_t	HDSL_get_events (HDSL_Handle hdslHandle)
	Taking values of High bytes event (EVENT_H) and Low bytes event(EVENT_L) More...

uint8_t	HDSL_get_safe_events (HDSL_Handle hdslHandle)
	Taking values of Safe Event (EVENT_S) register. More...

uint16_t	HDSL_get_online_status_d (HDSL_Handle hdslHandle)
	Taking values of Online Status D (ONLINE_STATUS_D) register. More...

uint16_t	HDSL_get_online_status_1 (HDSL_Handle hdslHandle)
	Taking values of Online Status D (ONLINE_STATUS_D) register. More...

uint16_t	HDSL_get_online_status_2 (HDSL_Handle hdslHandle)
	Taking values of Online Status D (ONLINE_STATUS_D) register. More...

uint8_t	HDSL_get_sum (HDSL_Handle hdslHandle)
	Getting Summarized slave status. More...

uint8_t	HDSL_get_acc_err_cnt (HDSL_Handle hdslHandle)
	Acceleration error counter. More...

uint8_t	HDSL_get_rssi (HDSL_Handle hdslHandle)
	Read RSSI value. More...

int32_t	HDSL_write_pc_short_msg (HDSL_Handle hdslHandle, uint8_t addr, uint8_t data, uint64_t timeout)
	Write Response of Short message parameters channel Read for safe1 channel(S_PC_DATA) with gPc_data and Short message control value(SLAVE_REG_CTRL) in hdsl interface. More...

int32_t	HDSL_read_pc_short_msg (HDSL_Handle hdslHandle, uint8_t addr, uint8_t *data, uint64_t timeout)
	Read Response of Short message parameters channel Read for safe1 channel(S_PC_DATA) and write Short message control value(SLAVE_REG_CTRL) with gPc_addr in hdsl interface. More...

void	HDSL_set_pc_addr (HDSL_Handle hdslHandle, uint8_t pc_addrh, uint8_t pc_addrl, uint8_t pc_offh, uint8_t pc_offl)
	Write PC_AAD_L ,PC_ADD_H ,PC_OFF_L,PC_OFF_H and PC_CTRL values in hdsl interface. More...

void	HDSL_set_pc_ctrl (HDSL_Handle hdslHandle, uint8_t value)
	To set the direction read/write for long message communication. More...

void	HDSL_write_pc_buffer (HDSL_Handle hdslHandle, uint8_t pc_buf0, uint8_t pc_buf1, uint8_t pc_buf2, uint8_t pc_buf3, uint8_t pc_buf4, uint8_t pc_buf5, uint8_t pc_buf6, uint8_t pc_buf7)
	Write Parameters channel buffer for different bytes(bytes 0-7) More...

uint8_t	HDSL_read_pc_buffer (HDSL_Handle hdslHandle, uint8_t buff_off)
	Returns Parameters channel buffer for different bytes(bytes 0-7) More...

uint8_t	HDSL_get_sync_ctrl (HDSL_Handle hdslHandle)
	Returns Synchronization control value. More...

void	HDSL_set_sync_ctrl (HDSL_Handle hdslHandle, uint8_t val)
	Writes Synchronization control value. More...

uint8_t	HDSL_get_master_qm (HDSL_Handle hdslHandle)
	Returns Quality monitoring value. More...

uint8_t	HDSL_get_edges (HDSL_Handle hdslHandle)
	Returns Cable bit sampling time control. More...

uint8_t	HDSL_get_delay (HDSL_Handle hdslHandle)
	Returns Run time delay of system cable and signal strength. More...

uint8_t	HDSL_get_enc_id (HDSL_Handle hdslHandle, int byte)
	Read encoder id bytes(byte no. 0-2) More...

void	HDSL_generate_memory_image (HDSL_Handle hdslHandle)
	Generates memory image. More...

void *	HDSL_get_src_loc (HDSL_Handle hdslHandle)
	Get memory location for HDSL interface struct. More...

uint32_t	HDSL_get_length (HDSL_Handle hdslHandle)
	Get size of memory used by HDSL interface struct. More...

Typedefs
typedef struct HDSL_Config_s *	HDSL_Handle

Macros
#define	MAX_WAIT 20000

#define	HDSL_ICSSG0_INST 0U

#define	HDSL_ICSSG1_INST 1U

#define	HWREG(x) (((volatile uint32_t )(x)))

#define	HWREGB(x) (((volatile uint8_t )(x)))

#define	HWREGH(x) (((volatile uint16_t )(x)))

#define	SYNCEVENT_INTRTR_IN_27 27

#define	SYNCEVT_RTR_SYNC28_EVT 0x64

#define	SYNCEVT_RTR_SYNC29_EVT 0x68

#define	SYNCEVT_RTR_SYNC30_EVT 0x6C

#define	SYNCEVT_RTR_SYNC31_EVT 0x70

#define	SYNCEVT_RTR_SYNC10_EVT 0x2C

Macro Definition Documentation

◆ MAX_WAIT

#define MAX_WAIT 20000

◆ HDSL_ICSSG0_INST

#define HDSL_ICSSG0_INST 0U

◆ HDSL_ICSSG1_INST

#define HDSL_ICSSG1_INST 1U

◆ HWREG

#define HWREG ( x ) (*((volatile uint32_t *)(x)))

◆ HWREGB

#define HWREGB ( x ) (*((volatile uint8_t *)(x)))

◆ HWREGH

#define HWREGH ( x ) (*((volatile uint16_t *)(x)))

◆ SYNCEVENT_INTRTR_IN_27

#define SYNCEVENT_INTRTR_IN_27 27

◆ SYNCEVT_RTR_SYNC28_EVT

#define SYNCEVT_RTR_SYNC28_EVT 0x64

◆ SYNCEVT_RTR_SYNC29_EVT

#define SYNCEVT_RTR_SYNC29_EVT 0x68

◆ SYNCEVT_RTR_SYNC30_EVT

#define SYNCEVT_RTR_SYNC30_EVT 0x6C

◆ SYNCEVT_RTR_SYNC31_EVT

#define SYNCEVT_RTR_SYNC31_EVT 0x70

◆ SYNCEVT_RTR_SYNC10_EVT

#define SYNCEVT_RTR_SYNC10_EVT 0x2C

Typedef Documentation

◆ HDSL_Handle

typedef struct HDSL_Config_s* HDSL_Handle

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
linear
rotary
MENU_SAFE_POSITION
MENU_QUALITY_MONITORING
MENU_EVENTS
MENU_SUMMARY
MENU_ACC_ERR_CNT
MENU_RSSI
MENU_PC_SHORT_MSG_WRITE
MENU_PC_SHORT_MSG_READ
MENU_PC_LONG_MSG_WRITE
MENU_HDSL_REG_INTO_DDR
MENU_HDSL_REG_INTO_DDR_GPIO
MENU_DIRECT_READ_RID0_LENGTH8
MENU_DIRECT_READ_RID81_LENGTH8
MENU_DIRECT_READ_RID81_LENGTH2
MENU_INDIRECT_WRITE_RID0_LENGTH8_OFFSET0
MENU_INDIRECT_WRITE_RID0_LENGTH8
MENU_DIRECT_READ_RID0_LENGTH8_OFFSET6
MENU_LIMIT
MENU_INVALID

Function Documentation

◆ hdsl_enable_load_share_mode()

void hdsl_enable_load_share_mode	(	void *	gPru_cfg,
		uint32_t	PRU_SLICE
	)

enable load share mode for multi-channel HDSL

Parameters

[in]	gPru_cfg	Cfg base register address
[in]	PRU_SLICE	PRU slice, 1 for PRU1 and 0 for PRU0

◆ HDSL_open()

HDSL_Handle HDSL_open	(	PRUICSS_Handle	icssgHandle,
		uint32_t	icssCore,
		uint8_t	PRU_mode
	)

Open HDSL handle for the specified core (interrupt mapping should already be completed)

Parameters

[in]	icssgHandle	PRUICSS_Handle for the ICSS instance
[in]	icssCore	Core to map in ICSSG instance
[in]	PRU_mode	0 for dissabled load share mode, 1 for enabled load share mode

Return values

HDSL_Handle

◆ HDSL_iep_init()

void HDSL_iep_init ( HDSL_Handle hdslHandle )

Initialize IEP and Use OCP as IEP CLK src.

Parameters

[in] hdslHandle

◆ HDSL_enable_sync_signal()

int HDSL_enable_sync_signal	(	uint8_t	ES,
		uint32_t	period
	)

Enable IEP
*Enable SYNC0 and program pulse width
Enable cyclic mod
Program CMP1
TSR configuration

Parameters

[in]	ES
[in]	period

Return values

1	for successful enable sync signal

◆ HDSL_get_pos()

uint64_t HDSL_get_pos	(	HDSL_Handle	hdslHandle,
		int	position_id
	)

Calculate fast position,safe position1,safe position2.

Parameters

[in]	hdslHandle
[in]	position_id

Return values

position value in integer for successful position return, -1 for error in position return

◆ HDSL_get_qm()

uint8_t HDSL_get_qm ( HDSL_Handle hdslHandle )

Getting quality monitoring value.

Parameters

[in] hdslHandle

Return values

8	bit integer QM value

◆ HDSL_get_events()

uint16_t HDSL_get_events ( HDSL_Handle hdslHandle )

Taking values of High bytes event (EVENT_H) and Low bytes event(EVENT_L)

Parameters

[in] hdslHandle

Return values

16	bit integer concatenated values of both EVENT_H,EVENT_L

◆ HDSL_get_safe_events()

uint8_t HDSL_get_safe_events ( HDSL_Handle hdslHandle )

Taking values of Safe Event (EVENT_S) register.

Parameters

[in] hdslHandle

Return values

8	bit integer values of EVENT_S

◆ HDSL_get_online_status_d()

uint16_t HDSL_get_online_status_d ( HDSL_Handle hdslHandle )

Taking values of Online Status D (ONLINE_STATUS_D) register.

Parameters

[in] hdslHandle

Return values

16	bit integer value of ONLINE_STATUS_D

◆ HDSL_get_online_status_1()

uint16_t HDSL_get_online_status_1 ( HDSL_Handle hdslHandle )

Taking values of Online Status D (ONLINE_STATUS_D) register.

Parameters

[in] hdslHandle

Return values

16	bit integer value of ONLINE_STATUS_D

◆ HDSL_get_online_status_2()

uint16_t HDSL_get_online_status_2 ( HDSL_Handle hdslHandle )

Taking values of Online Status D (ONLINE_STATUS_D) register.

Parameters

[in] hdslHandle

Return values

16	bit integer value of ONLINE_STATUS_D

◆ HDSL_get_sum()

uint8_t HDSL_get_sum ( HDSL_Handle hdslHandle )

Getting Summarized slave status.

Parameters

[in] hdslHandle

Return values

8	bit integer value of summarized status

◆ HDSL_get_acc_err_cnt()

uint8_t HDSL_get_acc_err_cnt ( HDSL_Handle hdslHandle )

Acceleration error counter.

Parameters

[in] hdslHandle

Return values

8	bit integer value of acceleration error counter

◆ HDSL_get_rssi()

uint8_t HDSL_get_rssi ( HDSL_Handle hdslHandle )

Read RSSI value.

Parameters

[in] hdslHandle

Return values

8	bit RSSI integer value

◆ HDSL_write_pc_short_msg()

int32_t HDSL_write_pc_short_msg	(	HDSL_Handle	hdslHandle,
		uint8_t	addr,
		uint8_t	data,
		uint64_t	timeout
	)

Write Response of Short message parameters channel Read for safe1 channel(S_PC_DATA) with gPc_data and Short message control value(SLAVE_REG_CTRL) in hdsl interface.

Parameters

[in]	hdslHandle
[in]	addr	Address
[in]	data	Data
[in]	timeout	Timeout in microseconds

Returns: SystemP_SUCCESS in case of success, SystemP_TIMEOUT in case of timeout

◆ HDSL_read_pc_short_msg()

int32_t HDSL_read_pc_short_msg	(	HDSL_Handle	hdslHandle,
		uint8_t	addr,
		uint8_t *	data,
		uint64_t	timeout
	)

Read Response of Short message parameters channel Read for safe1 channel(S_PC_DATA) and write Short message control value(SLAVE_REG_CTRL) with gPc_addr in hdsl interface.

Parameters

[in]	hdslHandle
[in]	addr	Address
[in]	data	Pointer to data buffer where read data will be stored
[in]	timeout	Timeout in microseconds

Returns: SystemP_SUCCESS in case of success, SystemP_TIMEOUT in case of timeout

◆ HDSL_set_pc_addr()

void HDSL_set_pc_addr	(	HDSL_Handle	hdslHandle,
		uint8_t	pc_addrh,
		uint8_t	pc_addrl,
		uint8_t	pc_offh,
		uint8_t	pc_offl
	)

Write PC_AAD_L ,PC_ADD_H ,PC_OFF_L,PC_OFF_H and PC_CTRL values in hdsl interface.

Parameters

[in]	hdslHandle
[in]	pc_addrh
[in]	pc_addrl
[in]	pc_offh
[in]	pc_offl

◆ HDSL_set_pc_ctrl()

void HDSL_set_pc_ctrl	(	HDSL_Handle	hdslHandle,
		uint8_t	value
	)

To set the direction read/write for long message communication.

Parameters

[in]	hdslHandle
[in]	value

◆ HDSL_write_pc_buffer()

void HDSL_write_pc_buffer	(	HDSL_Handle	hdslHandle,
		uint8_t	pc_buf0,
		uint8_t	pc_buf1,
		uint8_t	pc_buf2,
		uint8_t	pc_buf3,
		uint8_t	pc_buf4,
		uint8_t	pc_buf5,
		uint8_t	pc_buf6,
		uint8_t	pc_buf7
	)

Write Parameters channel buffer for different bytes(bytes 0-7)

Parameters

[in]	hdslHandle
[in]	pc_buf0
[in]	pc_buf1
[in]	pc_buf2
[in]	pc_buf3
[in]	pc_buf4
[in]	pc_buf5
[in]	pc_buf6
[in]	pc_buf7

◆ HDSL_read_pc_buffer()

uint8_t HDSL_read_pc_buffer	(	HDSL_Handle	hdslHandle,
		uint8_t	buff_off
	)

Returns Parameters channel buffer for different bytes(bytes 0-7)

Parameters

[in]	hdslHandle
[in]	buff_off

Return values

8	bit integer value of PC_BUFFER from hdsl interface

◆ HDSL_get_sync_ctrl()

uint8_t HDSL_get_sync_ctrl ( HDSL_Handle hdslHandle )

Returns Synchronization control value.

Parameters

[in] hdslHandle

Return values

8	bit integer value of SYNC_CTRL from hdsl interface

◆ HDSL_set_sync_ctrl()

void HDSL_set_sync_ctrl	(	HDSL_Handle	hdslHandle,
		uint8_t	val
	)

Writes Synchronization control value.

Parameters

[in]	hdslHandle
[in]	val

◆ HDSL_get_master_qm()

uint8_t HDSL_get_master_qm ( HDSL_Handle hdslHandle )

Returns Quality monitoring value.

Parameters

[in] hdslHandle

Return values

8	bit integer value of MASTER_QM from hdsl interface

◆ HDSL_get_edges()

uint8_t HDSL_get_edges ( HDSL_Handle hdslHandle )

Returns Cable bit sampling time control.

Parameters

[in] hdslHandle

Return values

8	bit integer value of EDGES from hdsl interface

◆ HDSL_get_delay()

uint8_t HDSL_get_delay ( HDSL_Handle hdslHandle )

Returns Run time delay of system cable and signal strength.

Parameters

[in] hdslHandle

Return values

8	bit integer value of DELAY from hdsl interface

◆ HDSL_get_enc_id()

uint8_t HDSL_get_enc_id	(	HDSL_Handle	hdslHandle,
		int	byte
	)

Read encoder id bytes(byte no. 0-2)

Parameters

[in]	hdslHandle
[in]	byte

Return values

8	bit encoder bytes data from hdsl interface

◆ HDSL_generate_memory_image()

void HDSL_generate_memory_image ( HDSL_Handle hdslHandle )

Generates memory image.

Parameters

[in] hdslHandle

◆ HDSL_get_src_loc()

void* HDSL_get_src_loc ( HDSL_Handle hdslHandle )

Get memory location for HDSL interface struct.

Parameters

[in] hdslHandle

Return values

Pointer containing base memeory address

◆ HDSL_get_length()

uint32_t HDSL_get_length ( HDSL_Handle hdslHandle )

Get size of memory used by HDSL interface struct.

Parameters

[in] hdslHandle

Return values

Size	of the struct

Enumerations
enum	{ linear, rotary, MENU_SAFE_POSITION, MENU_QUALITY_MONITORING, MENU_EVENTS, MENU_SUMMARY, MENU_ACC_ERR_CNT, MENU_RSSI, MENU_PC_SHORT_MSG_WRITE, MENU_PC_SHORT_MSG_READ, MENU_PC_LONG_MSG_WRITE, MENU_HDSL_REG_INTO_DDR, MENU_HDSL_REG_INTO_DDR_GPIO, MENU_DIRECT_READ_RID0_LENGTH8, MENU_DIRECT_READ_RID81_LENGTH8, MENU_DIRECT_READ_RID81_LENGTH2, MENU_INDIRECT_WRITE_RID0_LENGTH8_OFFSET0, MENU_INDIRECT_WRITE_RID0_LENGTH8, MENU_DIRECT_READ_RID0_LENGTH8_OFFSET6, MENU_LIMIT, MENU_INVALID }

Introduction

Data Structures

Functions

Typedefs

Enumerations

Macros

Macro Definition Documentation

◆ MAX_WAIT

◆ HDSL_ICSSG0_INST

◆ HDSL_ICSSG1_INST

◆ HWREG

◆ HWREGB

◆ HWREGH

◆ SYNCEVENT_INTRTR_IN_27

◆ SYNCEVT_RTR_SYNC28_EVT

◆ SYNCEVT_RTR_SYNC29_EVT

◆ SYNCEVT_RTR_SYNC30_EVT

◆ SYNCEVT_RTR_SYNC31_EVT

◆ SYNCEVT_RTR_SYNC10_EVT

Typedef Documentation

◆ HDSL_Handle

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ hdsl_enable_load_share_mode()

◆ HDSL_open()

◆ HDSL_iep_init()

◆ HDSL_enable_sync_signal()

◆ HDSL_get_pos()

◆ HDSL_get_qm()

◆ HDSL_get_events()

◆ HDSL_get_safe_events()

◆ HDSL_get_online_status_d()

◆ HDSL_get_online_status_1()

◆ HDSL_get_online_status_2()

◆ HDSL_get_sum()

◆ HDSL_get_acc_err_cnt()

◆ HDSL_get_rssi()

◆ HDSL_write_pc_short_msg()

◆ HDSL_read_pc_short_msg()

◆ HDSL_set_pc_addr()

◆ HDSL_set_pc_ctrl()

◆ HDSL_write_pc_buffer()

◆ HDSL_read_pc_buffer()

◆ HDSL_get_sync_ctrl()

◆ HDSL_set_sync_ctrl()

◆ HDSL_get_master_qm()

◆ HDSL_get_edges()

◆ HDSL_get_delay()

◆ HDSL_get_enc_id()

◆ HDSL_generate_memory_image()

◆ HDSL_get_src_loc()

◆ HDSL_get_length()