freebsd-skq/sys/contrib/octeon-sdk/cvmx-twsi.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

325 lines
10 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**************************************/
/**
* @file
*
* Interface to the TWSI / I2C bus
*
* Note: Currently on 7 bit device addresses are supported
*
* <hr>$Revision: 70030 $<hr>
*
*/
#ifndef __CVMX_TWSI_H__
#define __CVMX_TWSI_H__
#ifdef __cplusplus
extern "C" {
#endif
/* Extra TWSI Bus Opcodes */
#define TWSI_SLAVE_ADD 0
#define TWSI_DATA 1
#define TWSI_CTL 2
#define TWSI_CLKCTL_STAT 3 /* R=0 selects CLKCTL, R=1 selects STAT */
#define TWSI_STAT 3 /* when R = 1 */
#define TWSI_SLAVE_ADD_EXT 4
#define TWSI_RST 7
/**
* Do a twsi read from a 7 bit device address using an (optional) internal address.
* Up to 8 bytes can be read at a time.
*
* @param twsi_id which Octeon TWSI bus to use
* @param dev_addr Device address (7 bit)
* @param internal_addr
* Internal address. Can be 0, 1 or 2 bytes in width
* @param num_bytes Number of data bytes to read
* @param ia_width_bytes
* Internal address size in bytes (0, 1, or 2)
* @param data Pointer argument where the read data is returned.
*
* @return read data returned in 'data' argument
* Number of bytes read on success
* -1 on failure
*/
int cvmx_twsix_read_ia(int twsi_id, uint8_t dev_addr, uint16_t internal_addr, int num_bytes, int ia_width_bytes, uint64_t *data);
/**
* A convenience wrapper function around cvmx_twsix_read_ia() that
* only supports 8 bit internal addresses.
* Reads up to 7 bytes, and returns both the value read or error
* value in the return value
*
* @param twsi_id which Octeon TWSI bus to use
* @param dev_addr Device address (7 bit only)
* @param internal_addr
* Internal address (8 bit only)
* @param num_bytes Number of bytes to read (0-7)
*
* @return Value read from TWSI on success
* -1 on error
*/
static inline int64_t cvmx_twsix_read_ia8(int twsi_id, uint8_t dev_addr, uint8_t internal_addr, int num_bytes)
{
uint64_t data;
if (num_bytes < 1 || num_bytes > 7)
return -1;
if (cvmx_twsix_read_ia(twsi_id,dev_addr,internal_addr,num_bytes, 1, &data) < 0)
return -1;
return data;
}
/**
* A convenience wrapper function around cvmx_twsix_read_ia() that
* only supports 16 bit internal addresses.
* Reads up to 7 bytes, and returns both the value read or error
* value in the return value
*
* @param twsi_id which Octeon TWSI bus to use
* @param dev_addr Device address (7 bit only)
* @param internal_addr
* Internal address (16 bit only)
* @param num_bytes Number of bytes to read (0-7)
*
* @return Value read from TWSI on success
* -1 on error
*/
static inline int64_t cvmx_twsix_read_ia16(int twsi_id, uint8_t dev_addr, uint16_t internal_addr, int num_bytes)
{
uint64_t data;
if (num_bytes < 1 || num_bytes > 7)
return -1;
if (cvmx_twsix_read_ia(twsi_id, dev_addr, internal_addr, num_bytes, 2, &data) < 0)
return -1;
return data;
}
/**
* Read from a TWSI device (7 bit device address only) without generating any
* internal addresses.
* Read from 1-8 bytes and returns them in the data pointer.
*
* @param twsi_id TWSI interface on Octeon to use
* @param dev_addr TWSI device address (7 bit only)
* @param num_bytes number of bytes to read
* @param data Pointer to data read from TWSI device
*
* @return Number of bytes read on success
* -1 on error
*/
int cvmx_twsix_read(int twsi_id, uint8_t dev_addr, int num_bytes, uint64_t *data);
/**
* Perform a twsi write operation to a 7 bit device address.
*
* Note that many eeprom devices have page restrictions regarding address boundaries
* that can be crossed in one write operation. This is device dependent, and this routine
* does nothing in this regard.
* This command does not generate any internal addressess.
*
* @param twsi_id Octeon TWSI interface to use
* @param dev_addr TWSI device address
* @param num_bytes Number of bytes to write (between 1 and 8 inclusive)
* @param data Data to write
*
* @return 0 on success
* -1 on failure
*/
int cvmx_twsix_write(int twsi_id, uint8_t dev_addr, int num_bytes, uint64_t data);
/**
* Write 1-8 bytes to a TWSI device using an internal address.
*
* @param twsi_id which TWSI interface on Octeon to use
* @param dev_addr TWSI device address (7 bit only)
* @param internal_addr
* TWSI internal address (0, 8, or 16 bits)
* @param num_bytes Number of bytes to write (1-8)
* @param ia_width_bytes
* internal address width, in bytes (0, 1, 2)
* @param data Data to write. Data is written MSB first on the twsi bus, and only the lower
* num_bytes bytes of the argument are valid. (If a 2 byte write is done, only
* the low 2 bytes of the argument is used.
*
* @return Number of bytes read on success,
* -1 on error
*/
int cvmx_twsix_write_ia(int twsi_id, uint8_t dev_addr, uint16_t internal_addr, int num_bytes, int ia_width_bytes, uint64_t data);
/***********************************************************************
** Functions below are deprecated, and not recomended for use.
** They have been superceded by more flexible functions that are
** now provided.
************************************************************************/
/**
* Read 8-bit from a device on the TWSI / I2C bus
*
* @param twsi_id Which TWSI bus to use. CN3XXX, CN58XX, and CN50XX only
* support 0. CN56XX and CN57XX support 0-1.
* @param dev_addr I2C device address (7 bit)
* @param internal_addr
* Internal device address
*
* @return 8-bit data or < 0 in case of error
*/
static inline int cvmx_twsix_read8(int twsi_id, uint8_t dev_addr, uint8_t internal_addr)
{
return cvmx_twsix_read_ia8(twsi_id, dev_addr, internal_addr, 1);
}
/**
* Read 8-bit from a device on the TWSI / I2C bus
*
* Uses current internal address
*
* @param twsi_id Which TWSI bus to use. CN3XXX, CN58XX, and CN50XX only
* support 0. CN56XX and CN57XX support 0-1.
* @param dev_addr I2C device address (7 bit)
*
* @return 8-bit value or < 0 in case of error
*/
static inline int cvmx_twsix_read8_cur_addr(int twsi_id, uint8_t dev_addr)
{
uint64_t data;
if (cvmx_twsix_read(twsi_id,dev_addr, 1, &data) < 0)
return -1;
return(data & 0xff);
}
/**
* Write 8-bit to a device on the TWSI / I2C bus
*
* @param twsi_id Which TWSI bus to use. CN3XXX, CN58XX, and CN50XX only
* support 0. CN56XX and CN57XX support 0-1.
* @param dev_addr I2C device address (7 bit)
* @param internal_addr
* Internal device address
* @param data Data to be written
*
* @return 0 on success and < 0 in case of error
*/
static inline int cvmx_twsix_write8(int twsi_id, uint8_t dev_addr, uint8_t internal_addr, uint8_t data)
{
if (cvmx_twsix_write_ia(twsi_id,dev_addr,internal_addr, 1, 1,data) < 0)
return -1;
return 0;
}
/**
* Read 8-bit from a device on the TWSI / I2C bus zero.
*
* This function is for compatibility with SDK 1.6.0 and
* before which only supported a single TWSI bus.
*
* @param dev_addr I2C device address (7 bit)
* @param internal_addr
* Internal device address
*
* @return 8-bit data or < 0 in case of error
*/
static inline int cvmx_twsi_read8(uint8_t dev_addr, uint8_t internal_addr)
{
return cvmx_twsix_read8(0, dev_addr, internal_addr);
}
/**
* Read 8-bit from a device on the TWSI / I2C bus zero.
*
* Uses current internal address
*
* This function is for compatibility with SDK 1.6.0 and
* before which only supported a single TWSI bus.
*
* @param dev_addr I2C device address (7 bit)
*
* @return 8-bit value or < 0 in case of error
*/
static inline int cvmx_twsi_read8_cur_addr(uint8_t dev_addr)
{
return cvmx_twsix_read8_cur_addr(0, dev_addr);
}
/**
* Write 8-bit to a device on the TWSI / I2C bus zero.
* This function is for compatibility with SDK 1.6.0 and
* before which only supported a single TWSI bus.
*
* @param dev_addr I2C device address (7 bit)
* @param internal_addr
* Internal device address
* @param data Data to be written
*
* @return 0 on success and < 0 in case of error
*/
static inline int cvmx_twsi_write8(uint8_t dev_addr, uint8_t internal_addr, uint8_t data)
{
return cvmx_twsix_write8(0, dev_addr, internal_addr, data);
}
#ifdef __cplusplus
}
#endif
#endif /* __CVMX_TWSI_H__ */