freebsd-nq/sys/contrib/octeon-sdk/cvmx-ixf18201.h
Juli Mallett dc4ee6ca91 Merge the Cavium Octeon SDK 2.3.0 Simple Executive code and update FreeBSD to
make use of it where possible.

This primarily brings in support for newer hardware, and FreeBSD is not yet
able to support the abundance of IRQs on new hardware and many features in the
Ethernet driver.

Because of the changes to IRQs in the Simple Executive, we have to maintain our
own list of Octeon IRQs now, which probably can be pared-down and be specific
to the CIU interrupt unit soon, and when other interrupt mechanisms are added
they can maintain their own definitions.

Remove unmasking of interrupts from within the UART device now that the
function used is no longer present in the Simple Executive.  The unmasking
seems to have been gratuitous as this is more properly handled by the buses
above the UART device, and seems to work on that basis.
2012-03-11 06:17:49 +00:00

113 lines
3.5 KiB
C

/***********************license start***************
* Copyright (c) 2003-2010 Cavium Inc. (support@cavium.com). All rights
* reserved.
*
*
* 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 Cavium Inc. 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, including technical data, may be subject to U.S. export control
* laws, including the U.S. Export Administration Act and its associated
* regulations, and may be subject to export or import regulations in other
* countries.
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
* THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
* DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
* SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
* MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
* VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
* CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR
* PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
***********************license end**************************************/
#ifndef __CVMX_IXF18201_H__
#define __CVMX_IXF18201_H__
#ifdef __cplusplus
extern "C" {
#endif
/**
* Initialize the IXF18201 SPI<->XAUI MAC.
* @return 1 on success
* 0 on failure
*/
int cvmx_ixf18201_init(void);
/**
* Read a 16 bit register from the IXF18201
*
* @param reg_addr Register address
*
* @return 16 bit register value
*/
uint16_t cvmx_ixf18201_read16(uint16_t reg_addr);
/**
* Write a 16 bit IXF18201 register
*
* @param reg_addr Register address
* @param data Value to write
*
*/
void cvmx_ixf18201_write16(uint16_t reg_addr, uint16_t data);
/**
* Write a 16 bit IXF18201 register
*
* @param reg_addr Register address (must be 4 byte aligned)
*
* @return 32 bit register value
*/
uint32_t cvmx_ixf18201_read32(uint16_t reg_addr);
/**
* Write a 32 bit IXF18201 register
*
* @param reg_addr Register address (must be 4 byte aligned)
* @param data Value to write
*
*/
void cvmx_ixf18201_write32(uint16_t reg_addr, uint32_t data);
/**
* Performs an MII clause 45 write using the MII block in IXF18201.
*
* @param mii_addr Device MII address
* @param mmd MMD address (block within device)
* @param reg Register address
* @param val Value to write
*/
void cvmx_ixf18201_mii_write(int mii_addr, int mmd, uint16_t reg, uint16_t val);
/**
* Performs an MII clause 45 read using the MII block in IXF18201.
*
* @param mii_addr Device MII address
* @param mmd MMD address (block within device)
* @param reg Register address
* @return register value read from device
*/
int cvmx_ixf18201_mii_read(int mii_addr, int mmd, uint16_t reg);
#ifdef __cplusplus
}
#endif
#endif /* __CVMX_IXF18201_H__ */