hsrPrp_red_multicastTable.h File Reference

Introduction

Include file for hsrPrp_red_multicastTable.c.

Copyright (C) 2021 Texas Instruments Incorporated

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Go to the source code of this file.

Functions
RED_STATUS	hsrPrp_multicast_filter_config (PRUICSS_Handle pruicssHandle, uint8_t command)
	set the M_MULTICAST_TABLE_SEARCH_OP_CONTROL_BIT to enable/disable multicast filtering More...
RED_STATUS	hsrPrp_multicast_filter_update_macid (PRUICSS_Handle pruicssHandle, uint8_t *multicastAddr, uint8_t command)
	insert/delete a multicast MAC ID in the multicast filter table More...
RED_STATUS	hsrPrp_multicast_filter_override_hashmask (PRUICSS_Handle pruicssHandle, uint8_t *mask)
	configure the mask More...

Function Documentation

hsrPrp_multicast_filter_config()

RED_STATUS hsrPrp_multicast_filter_config	(	PRUICSS_Handle	pruicssHandle,
		uint8_t	command
	)

set the M_MULTICAST_TABLE_SEARCH_OP_CONTROL_BIT to enable/disable multicast filtering

Parameters

pruicssHandle	Handle to PRU ICSS instance. Contains pointers to base addresses & offsets
command	instruction to enable/disable multicast filtering. Command can take 2 values: MULTICAST_FILTER_DISABLED 0x00 MULTICAST_FILTER_ENABLED 0x01

Returns

RED_OK on success, RED_ERR otherwise

hsrPrp_multicast_filter_update_macid()

RED_STATUS hsrPrp_multicast_filter_update_macid	(	PRUICSS_Handle	pruicssHandle,
		uint8_t *	multicastAddr,
		uint8_t	command
	)

insert/delete a multicast MAC ID in the multicast filter table

Parameters

pruicssHandle	Handle to PRU ICSS instance. Contains pointers to base addresses & offsets
multicastAddr	multicast address to be inserted/deleted into the multicast filter table
command	instruction to enable/disable multicast filtering. Command can take 2 values: 0 : allow packet to host | ADD_MULTICAST_MAC_ID 1 : do not allow packet to host | REMOVE_MULTICAST_MAC_ID

Returns

RED_OK on success, RED_ERR otherwise

hsrPrp_multicast_filter_override_hashmask()

RED_STATUS hsrPrp_multicast_filter_override_hashmask	(	PRUICSS_Handle	pruicssHandle,
		uint8_t *	mask
	)

configure the mask

Parameters

pruicssHandle	Handle to PRU ICSS instance. Contains pointers to base addresses & offsets
mask	mask to be set

Returns

RED_OK on success, RED_ERR otherwise