mirror of
https://github.com/gnuton/asuswrt-merlin.ng.git
synced 2025-05-19 16:02:36 +02:00
205 lines
6 KiB
C
205 lines
6 KiB
C
/***********************************************************************
|
|
*
|
|
* Copyright (c) 2007 Broadcom Corporation
|
|
* All Rights Reserved
|
|
*
|
|
* <:label-BRCM:2011:DUAL/GPL:standard
|
|
*
|
|
* Unless you and Broadcom execute a separate written software license
|
|
* agreement governing use of this software, this software is licensed
|
|
* to you under the terms of the GNU General Public License version 2
|
|
* (the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php,
|
|
* with the following added to such license:
|
|
*
|
|
* As a special exception, the copyright holders of this software give
|
|
* you permission to link this software with independent modules, and
|
|
* to copy and distribute the resulting executable under terms of your
|
|
* choice, provided that you also meet, for each linked independent
|
|
* module, the terms and conditions of the license of that module.
|
|
* An independent module is a module which is not derived from this
|
|
* software. The special exception does not apply to any modifications
|
|
* of the software.
|
|
*
|
|
* Not withstanding the above, under no circumstances may you combine
|
|
* this software in any way with any other Broadcom software provided
|
|
* under a license other than the GPL, without Broadcom's express prior
|
|
* written consent.
|
|
*
|
|
:>
|
|
*
|
|
************************************************************************/
|
|
|
|
|
|
#ifndef __BCM_BOARDCTL_H__
|
|
#define __BCM_BOARDCTL_H__
|
|
|
|
#include <sys/ioctl.h>
|
|
#include "bcm_retcodes.h"
|
|
#include "number_defs.h"
|
|
|
|
/*!\file bcm_boardctl.h
|
|
* \brief Header file for various board ioctls.
|
|
*
|
|
* These functions are the simple board control functions that other apps,
|
|
* including GPL apps, may need. These functions are mostly just wrappers
|
|
* around devCtl_boardDriverIoctl().
|
|
*
|
|
*/
|
|
|
|
|
|
/** Get the board's br0 interface mac address.
|
|
*
|
|
* @param macAddrNum (OUT) The user must pass in an array of UINT8 of at least
|
|
* MAC_ADDR_LEN (6) bytes long.
|
|
*
|
|
* @return BcmRet enum.
|
|
*/
|
|
BcmRet devCtl_getBaseMacAddress(UINT8 *macAddrNum);
|
|
|
|
|
|
/** Get the available interface mac address.
|
|
*
|
|
* @param macAddrNum (OUT) The user must pass in an array of UINT8 of at least
|
|
* MAC_ADDR_LEN (6) bytes long.
|
|
*
|
|
* @return BcmRet enum.
|
|
*/
|
|
BcmRet devCtl_getMacAddress(UINT8 *macAddrNum, UINT32 ulId);
|
|
|
|
|
|
/** Get the given number of consecutive available mac addresses.
|
|
*
|
|
* @param macAddrNum (OUT) The user must pass in an array of UINT8 of at least
|
|
* MAC_ADDR_LEN (6) bytes long.
|
|
*
|
|
* @return BcmRet enum.
|
|
*/
|
|
BcmRet devCtl_getMacAddresses(UINT8 *macAddrNum, UINT32 ulId, UINT32 num_addresses);
|
|
|
|
/** Releases the given number of consecutive mac addresses
|
|
*
|
|
* @param macAddrNum (OUT) The user must pass in an array of UINT8 of at least
|
|
* MAC_ADDR_LEN (6) bytes long.
|
|
*
|
|
* @return BcmRet enum.
|
|
*/
|
|
BcmRet devCtl_releaseMacAddresses(UINT8 *macAddrNum, UINT32 num_addresses);
|
|
|
|
/** Release the interface mac address that is not used anymore
|
|
*
|
|
* @param macAddrNum (OUT) The user must pass in an array of UINT8 of at least
|
|
* MAC_ADDR_LEN (6) bytes long.
|
|
*
|
|
* @return BcmRet enum.
|
|
*/
|
|
BcmRet devCtl_releaseMacAddress(UINT8 *macAddrNum);
|
|
|
|
|
|
/** Get the number of ethernet MACS on the system.
|
|
*
|
|
* @return number of ethernet MACS.
|
|
*/
|
|
UINT32 devCtl_getNumEnetMacs(void);
|
|
|
|
|
|
/** Get the number of ethernet ports on the system.
|
|
*
|
|
* @return number of ethernet ports.
|
|
*/
|
|
UINT32 devCtl_getNumEnetPorts(void);
|
|
|
|
|
|
/** Get SDRAM size on the system.
|
|
*
|
|
* @return SDRAM size in number of bytes.
|
|
*/
|
|
UINT32 devCtl_getSdramSize(void);
|
|
|
|
|
|
/** Get the chipId.
|
|
*
|
|
* This info is used in various places, including CLI and writing new
|
|
* flash image. It may be accessed by GPL apps, so it cannot be put
|
|
* exclusively in the data model.
|
|
*
|
|
* @param chipId (OUT) The chip id returned by the kernel.
|
|
* @return BcmRet enum.
|
|
*/
|
|
BcmRet devCtl_getChipId(UINT32 *chipId);
|
|
|
|
|
|
#if defined(EPON_SDK_BUILD)
|
|
/** Get mac type for a specified uni port
|
|
*
|
|
* @return success or failure.
|
|
*/
|
|
|
|
UINT32 devCtl_getPortMacType(unsigned short port, unsigned int *mac_type);
|
|
|
|
/** Get the number of FE ports on the system.
|
|
*
|
|
* @return success or failure.
|
|
*/
|
|
UINT32 devCtl_getNumFePorts(unsigned int *fe_ports);
|
|
|
|
/** Get the number of GE ports on the system.
|
|
*
|
|
* @return success or failure.
|
|
*/
|
|
UINT32 devCtl_getNumGePorts(unsigned int *ge_ports);
|
|
|
|
/** Get the number of VoIP ports on the system.
|
|
*
|
|
* @return success or failure.
|
|
*/
|
|
UINT32 devCtl_getNumVoipPorts(unsigned int *voip_ports);
|
|
|
|
/** Get the port_map of internal switch ports used.
|
|
*
|
|
* @return success or failure.
|
|
*/
|
|
UINT32 devCtl_getPortMap(unsigned int *port_map);
|
|
|
|
#endif /* EPON_SDK_BUILD */
|
|
|
|
/** Get list of all keys/tokenID's in the scratch pad.
|
|
*
|
|
* @return greater than 0 means number of bytes copied to tokBuf,
|
|
* 0 means fail,
|
|
* negative number means provided buffer is not big enough and the
|
|
* absolute value of the negative number is the number of bytes needed.
|
|
*/
|
|
SINT32 devCtl_scratchPadList(const char *fileName, char *tokBuf, int bufLen);
|
|
|
|
/** Get a buffer from the scratch pad based on tokenId.
|
|
*
|
|
* @return greater than 0 means number of bytes copied to tokBuf,
|
|
* 0 means fail,
|
|
* negative number means provided buffer is not big enough and the
|
|
* absolute value of the negative number is the number of bytes needed.
|
|
*/
|
|
SINT32 devCtl_scratchPadGet(const char *fileName,
|
|
char *tokenId, char *tokBuf, int bufLen);
|
|
|
|
/** Set contents of a scratch pad buffer identified by tokenId.
|
|
*
|
|
* @return 0 - ok, -1 - fail.
|
|
*/
|
|
SINT32 devCtl_scratchPadSet(const char *fileName,
|
|
char *tokenId, char *tokBuf, int bufLen);
|
|
|
|
/** Wipe out the scratchPad.
|
|
*
|
|
* @return 0 - ok, -1 - fail.
|
|
*/
|
|
SINT32 devCtl_scratchPadClearAll(const char *fileName);
|
|
|
|
/** Read file into given buffer.
|
|
*/
|
|
SINT32 devCtl_flashReadFile(const char *fileName, char *buf, UINT32 bufLen);
|
|
|
|
/** Write buf into fname.
|
|
*/
|
|
SINT32 devCtl_flashWriteFile(const char *fileName, char *buf, UINT32 bufLen);
|
|
|
|
#endif /* __BCM_BOARDCTL_H__ */
|