xref: /freebsd/sys/dev/bhnd/siba/siba_subr.c (revision 4ad7e9b01a7a6b2059e17869220ad48740da4e5d)

/*-
 * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
 *    redistribution must be conditioned upon including a substantially
 *    similar Disclaimer requirement for further binary redistribution.
 *
 * NO WARRANTY
 * 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 NONINFRINGEMENT, MERCHANTIBILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <sys/param.h>
#include <sys/bus.h>
#include <sys/kernel.h>
#include <sys/limits.h>
#include <sys/systm.h>

#include <machine/bus.h>
#include <machine/resource.h>

#include <dev/bhnd/bhndvar.h>

#include "sibareg.h"
#include "sibavar.h"

/**
 * Map a siba(4) OCP vendor code to its corresponding JEDEC JEP-106 vendor
 * code.
 *
 * @param ocp_vendor An OCP vendor code.
 * @return The BHND_MFGID constant corresponding to @p ocp_vendor, or
 * BHND_MFGID_INVALID if the OCP vendor is unknown.
 */
uint16_t
siba_get_bhnd_mfgid(uint16_t ocp_vendor)
{
	switch (ocp_vendor) {
	case OCP_VENDOR_BCM:
		return (BHND_MFGID_BCM);
	default:
		return (BHND_MFGID_INVALID);
	}
}

/**
 * Parse the SIBA_IDH_* fields from the per-core identification
 * registers, returning a siba_core_id representation.
 *
 * @param idhigh The SIBA_R0_IDHIGH register.
 * @param idlow The SIBA_R0_IDLOW register.
 * @param core_id The core id (index) to include in the result.
 * @param unit The unit number to include in the result.
 */
struct siba_core_id
siba_parse_core_id(uint32_t idhigh, uint32_t idlow, u_int core_idx, int unit)
{

	uint16_t	ocp_vendor;
	uint8_t		sonics_rev;
	uint8_t		num_addrspace;
	uint8_t		num_cfg;

	ocp_vendor = SIBA_REG_GET(idhigh, IDH_VENDOR);
	sonics_rev = SIBA_REG_GET(idlow, IDL_SBREV);
	num_addrspace = SIBA_REG_GET(idlow, IDL_NRADDR) + 1 /* + enum block */;

	/* Determine the number of sonics config register blocks */
	num_cfg = SIBA_CFG_NUM_2_2;
	if (sonics_rev >= SIBA_IDL_SBREV_2_3)
		num_cfg = SIBA_CFG_NUM_2_3;

	return (struct siba_core_id) {
		.core_info	= {
			.vendor	= siba_get_bhnd_mfgid(ocp_vendor),
			.device	= SIBA_REG_GET(idhigh, IDH_DEVICE),
			.hwrev	= SIBA_IDH_CORE_REV(idhigh),
			.core_idx = core_idx,
			.unit	= unit
		},
		.sonics_vendor	= ocp_vendor,
		.sonics_rev	= sonics_rev,
		.num_addrspace	= num_addrspace,
		.num_cfg_blocks	= num_cfg
	};
}

/**
 * Initialize new port descriptor.
 *
 * @param port_num Port number.
 * @param port_type Port type.
 */
static void
siba_init_port(struct siba_port *port, bhnd_port_type port_type, u_int port_num)
{
	port->sp_num = port_num;
	port->sp_type = port_type;
	port->sp_num_addrs = 0;
	STAILQ_INIT(&port->sp_addrs);
}

/**
 * Deallocate all resources associated with the given port descriptor.
 *
 * @param port Port descriptor to be deallocated.
 */
static void
siba_release_port(struct siba_port *port) {
	struct siba_addrspace *as, *as_next;

	STAILQ_FOREACH_SAFE(as, &port->sp_addrs, sa_link, as_next) {
		free(as, M_BHND);
	}
}

/**
 * Allocate and initialize new device info structure, copying the
 * provided core id.
 *
 * @param dev The requesting bus device.
 * @param core Device core info.
 */
struct siba_devinfo *
siba_alloc_dinfo(device_t bus, const struct siba_core_id *core_id)
{
	struct siba_devinfo *dinfo;

	dinfo = malloc(sizeof(struct siba_devinfo), M_BHND, M_NOWAIT);
	if (dinfo == NULL)
		return NULL;

	dinfo->core_id = *core_id;

	for (u_int i = 0; i < nitems(dinfo->cfg); i++) {
		dinfo->cfg[i] = NULL;
		dinfo->cfg_rid[i] = -1;
	}

	siba_init_port(&dinfo->device_port, BHND_PORT_DEVICE, 0);
	resource_list_init(&dinfo->resources);

	return dinfo;
}

/**
 * Return the @p dinfo port instance for @p type, or NULL.
 *
 * @param dinfo The siba device info.
 * @param type The requested port type.
 *
 * @retval siba_port If @p port_type and @p port_num are defined on @p dinfo.
 * @retval NULL If the requested port is not defined on @p dinfo.
 */
struct siba_port *
siba_dinfo_get_port(struct siba_devinfo *dinfo, bhnd_port_type port_type,
    u_int port_num)
{
	/* We only define a single port for any given type. */
	if (port_num != 0)
		return (NULL);

	switch (port_type) {
	case BHND_PORT_DEVICE:
		return (&dinfo->device_port);
	case BHND_PORT_BRIDGE:
		return (NULL);
	case BHND_PORT_AGENT:
		return (NULL);
	}
}


/**
 * Find an address space with @p sid on @p port.
 *
 * @param port The port to search for a matching address space.
 * @param sid The siba-assigned address space ID to search for.
 */
struct siba_addrspace *
siba_find_port_addrspace(struct siba_port *port, uint8_t sid)
{
	struct siba_addrspace	*addrspace;

	STAILQ_FOREACH(addrspace, &port->sp_addrs, sa_link) {
		if (addrspace->sa_sid == sid)
			return (addrspace);
	}

	/* not found */
	return (NULL);
}

/**
 * Append a new address space entry to @p port_num of type @p port_type
 * in @p dinfo.
 *
 * The range will also be registered in @p dinfo resource list.
 *
 * @param dinfo The device info entry to update.
 * @param port_type The port type.
 * @param port_num The port number.
 * @param region_num The region index number.
 * @param sid The siba-assigned core-unique address space identifier.
 * @param base The mapping's base address.
 * @param size The mapping size.
 * @param bus_reserved Number of bytes to reserve in @p size for bus use
 * when registering the resource list entry. This is used to reserve bus
 * access to the core's SIBA_CFG* register blocks.
 *
 * @retval 0 success
 * @retval non-zero An error occurred appending the entry.
 */
int
siba_append_dinfo_region(struct siba_devinfo *dinfo, bhnd_port_type port_type,
    u_int port_num, u_int region_num, uint8_t sid, uint32_t base, uint32_t size,
    uint32_t bus_reserved)
{
	struct siba_addrspace	*sa;
	struct siba_port	*port;

	/* Verify that base + size will not overflow */
	if (UINT32_MAX - size < base)
		return (ERANGE);

	/* Must not be 0-length */
	if (size == 0)
		return (EINVAL);

	/* Determine target port */
	port = siba_dinfo_get_port(dinfo, port_type, port_num);
	if (port == NULL)
		return (EINVAL);

	/* Allocate new addrspace entry */
	sa = malloc(sizeof(*sa), M_BHND, M_NOWAIT|M_ZERO);
	if (sa == NULL)
		return (ENOMEM);

	sa->sa_base = base;
	sa->sa_size = size;
	sa->sa_sid = sid;
	sa->sa_region_num = region_num;

	/* Populate the resource list */
	size -= bus_reserved;
	sa->sa_rid = resource_list_add_next(&dinfo->resources, SYS_RES_MEMORY,
	    base, base + size - 1, size);

	/* Append to target port */
	STAILQ_INSERT_TAIL(&port->sp_addrs, sa, sa_link);
	port->sp_num_addrs++;

	return (0);
}

/**
 * Deallocate the given device info structure and any associated resources.
 *
 * @param dev The requesting bus device.
 * @param dinfo Device info to be deallocated.
 */
void
siba_free_dinfo(device_t dev, struct siba_devinfo *dinfo)
{
	siba_release_port(&dinfo->device_port);

	resource_list_free(&dinfo->resources);

	/* Free all mapped configuration blocks */
	for (u_int i = 0; i < nitems(dinfo->cfg); i++) {
		if (dinfo->cfg[i] == NULL)
			continue;

		bhnd_release_resource(dev, SYS_RES_MEMORY, dinfo->cfg_rid[i],
		    dinfo->cfg[i]);

		dinfo->cfg[i] = NULL;
		dinfo->cfg_rid[i] = -1;
	}

	free(dinfo, M_BHND);
}

/**
 * Return the core-enumeration-relative offset for the @p addrspace
 * SIBA_R0_ADMATCH* register.
 *
 * @param addrspace The address space index.
 *
 * @retval non-zero success
 * @retval 0 the given @p addrspace index is not supported.
 */
u_int
siba_admatch_offset(uint8_t addrspace)
{
	switch (addrspace) {
	case 0:
		return SB0_REG_ABS(SIBA_CFG0_ADMATCH0);
	case 1:
		return SB0_REG_ABS(SIBA_CFG0_ADMATCH1);
	case 2:
		return SB0_REG_ABS(SIBA_CFG0_ADMATCH2);
	case 3:
		return SB0_REG_ABS(SIBA_CFG0_ADMATCH3);
	default:
		return (0);
	}
}

/**
 * Parse a SIBA_R0_ADMATCH* register.
 *
 * @param addrspace The address space index.
 * @param am The address match register value to be parsed.
 * @param[out] addr The parsed address.
 * @param[out] size The parsed size.
 *
 * @retval 0 success
 * @retval non-zero a parse error occured.
 */
int
siba_parse_admatch(uint32_t am, uint32_t *addr, uint32_t *size)
{
	u_int		am_type;

	/* Negative encoding is not supported. This is not used on any
	 * currently known devices*/
	if (am & SIBA_AM_ADNEG)
		return (EINVAL);

	/* Extract the base address and size */
	am_type = SIBA_REG_GET(am, AM_TYPE);
	switch (am_type) {
	case 0:
		*addr = am & SIBA_AM_BASE0_MASK;
		*size = 1 << (SIBA_REG_GET(am, AM_ADINT0) + 1);
		break;
	case 1:
		*addr = am & SIBA_AM_BASE1_MASK;
		*size = 1 << (SIBA_REG_GET(am, AM_ADINT1) + 1);
		break;
	case 2:
		*addr = am & SIBA_AM_BASE2_MASK;
		*size = 1 << (SIBA_REG_GET(am, AM_ADINT2) + 1);
		break;
	default:
		return (EINVAL);
	}

	return (0);
}