xref: /src/sys/arch/arm/s3c2xx0/s3c2440_spi.c

/*-
 * Copyright (c) 2012 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Paul Fleischer <paul (at) xpg.dk>
 *
 * 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.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
 */

/* Derived from s3c2410_spi.c */

/*
 * Copyright (c) 2004  Genetec Corporation.  All rights reserved.
 * Written by Hiroyuki Bessho for Genetec Corporation.
 *
 * 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.
 * 2. 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.
 * 3. The name of Genetec Corporation may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY GENETEC CORPORATION ``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 GENETEC CORPORATION
 * 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.
 */

/*
 * Support S3C2440's SPI driver.
 * Real works are done by drivers attached to SPI ports.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: s3c2440_spi.c,v 1.5 2025/02/21 20:31:16 andvar Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/conf.h>

#include <sys/mutex.h>
#include <sys/condvar.h>

#include <sys/bus.h>
#include <machine/cpu.h>

#include <arm/s3c2xx0/s3c24x0var.h>
#include <arm/s3c2xx0/s3c24x0reg.h>
#include <arm/s3c2xx0/s3c2440reg.h>

#include <arm/s3c2xx0/s3c24x0_spi.h>

#include "locators.h"

struct ssspi_softc {
	bus_space_tag_t		iot;
	bus_space_handle_t	ioh;
	short			index;

	void			*sc_ih;
	struct kmutex		sc_intr_mtx;
	struct kcondvar		sc_intr_cv;
	uint8_t			sc_rxbyte;
	bool			sc_received;
};


/* prototypes */
static int	ssspi_match(device_t, cfdata_t, void *);
static void	ssspi_attach(device_t, device_t, void *);
static int	ssspi_search(device_t, cfdata_t, const int *, void *);
static int	ssspi_print(void *, const char *);
 int	ssspi_intr(void *arg);

/* attach structures */
CFATTACH_DECL_NEW(ssspi, sizeof(struct ssspi_softc), ssspi_match, ssspi_attach,
    NULL, NULL);


static int
ssspi_print(void *aux, const char *name)
{
	struct ssspi_attach_args *spia = aux;

	if (spia->spia_aux_intr != SSSPICF_INTR_DEFAULT)
		printf(" intr %d", spia->spia_aux_intr);
	return (UNCONF);
}

int
ssspi_match(device_t parent, cfdata_t match, void *aux)
{
	struct s3c2xx0_attach_args *sa = aux;

	/* S3C2440 have only two SPIs */
	switch (sa->sa_index) {
	case 0:
	case 1:
		break;
	default:
		return 0;
	}

	return 1;
}

void
ssspi_attach(device_t parent, device_t self, void *aux)
{
	struct ssspi_softc *sc = device_private(self);
	struct s3c2xx0_attach_args *sa = aux;
	bus_space_tag_t iot = sa->sa_iot;

	static bus_space_handle_t spi_ioh = 0;

	/* we map all registers for SPI0 and SPI1 at once, then
	   use subregions */
	if (spi_ioh == 0) {
		if (bus_space_map(iot, S3C2440_SPI0_BASE,
				  2 * S3C24X0_SPI_SIZE,
				  0, &spi_ioh)) {
			aprint_error(": can't map registers\n");
			return;
		}
	}

	aprint_normal("\n");

	sc->index = sa->sa_index;
	sc->iot = iot;

	bus_space_subregion(iot, spi_ioh, sc->index == 0 ? 0 : S3C24X0_SPI_SIZE,
	    S3C24X0_SPI_SIZE, &sc->ioh);

	mutex_init(&sc->sc_intr_mtx, MUTEX_DEFAULT, IPL_BIO);
	cv_init(&sc->sc_intr_cv, "S3C2440_spiintr");

	/*
	 *  Attach child devices
	 */
	config_search(self, NULL,
	    CFARGS(.search = ssspi_search));
}

int
ssspi_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
{
	struct ssspi_softc *sc = device_private(parent);
	struct ssspi_attach_args spia;
	static const unsigned char intr[] = { S3C24X0_INT_SPI0,
					      S3C2440_INT_SPI1 };

	KASSERT(sc->index == 0 || sc->index == 1);

	spia.spia_iot = sc->iot;
	spia.spia_ioh = sc->ioh;
	spia.spia_gpioh = s3c2xx0_softc->sc_gpio_ioh;
	spia.spia_index = sc->index;
	spia.spia_intr = intr[sc->index];
	spia.spia_aux_intr = cf->cf_loc[SSSPICF_INTR];
	spia.spia_dmat = s3c2xx0_softc->sc_dmat;

	if (config_probe(parent, cf, &spia))
		config_attach(parent, cf, &spia, ssspi_print, CFARGS_NONE);

	return 0;
}

/*
 * Intiialze SPI port. called by child devices.
 */
int
s3c24x0_spi_setup(struct ssspi_softc *sc, uint32_t mode, int bps, int use_ss)
{
	int pclk = s3c2xx0_softc->sc_pclk;
	int prescaler;
	uint32_t pgcon, pecon, peup;
	bus_space_handle_t gpioh = s3c2xx0_softc->sc_gpio_ioh;
	bus_space_tag_t iot = sc->iot;

	if (bps > 1) {
		prescaler = pclk / 2 / bps - 1;

		if (prescaler <= 0 || 0xff < prescaler)
			return -1;
		bus_space_write_1(sc->iot, sc->ioh, SPI_SPPRE, prescaler);
	}

	if (sc->index == 0) {
		pecon = bus_space_read_4(iot, gpioh, GPIO_PECON);

		if (use_ss) {
			pgcon = bus_space_read_4(iot, gpioh, GPIO_PGCON);
			pgcon = GPIO_SET_FUNC(pgcon, 2, PCON_ALTFUN2);
			bus_space_write_4(iot, gpioh, GPIO_PGCON, pgcon);
		}

		pecon = GPIO_SET_FUNC(pecon, 11, PCON_ALTFUN); /* SPIMISO0 */
		pecon = GPIO_SET_FUNC(pecon, 12, PCON_ALTFUN); /* SPIMOSI0 */
		pecon = GPIO_SET_FUNC(pecon, 13, PCON_ALTFUN); /* SPICL0 */

		bus_space_write_4(iot, gpioh, GPIO_PECON, pecon);

		/* Enable pull-up for pin 11, 12, and 13*/
		peup = bus_space_read_4(iot, gpioh, GPIO_PEUP);
		peup &= ~(1<<11);
		peup &= ~(1<<12);
		peup &= ~(1<<13);
		bus_space_write_4(iot, gpioh, GPIO_PEUP, peup);

		sc->sc_ih = s3c24x0_intr_establish(S3C24X0_INT_SPI0, IPL_BIO,
						   IST_EDGE_RISING, ssspi_intr,
						   sc);
		printf("ih: %p\n", sc->sc_ih);
	} else {
		pgcon = bus_space_read_4(iot, gpioh, GPIO_PGCON);

		if (use_ss)
			pgcon = GPIO_SET_FUNC(pgcon, 3, PCON_ALTFUN2);

		pgcon = GPIO_SET_FUNC(pgcon, 5, PCON_ALTFUN2); /* SPIMISO1 */
		pgcon = GPIO_SET_FUNC(pgcon, 6, PCON_ALTFUN2); /* SPIMOSI1 */
		pgcon = GPIO_SET_FUNC(pgcon, 7, PCON_ALTFUN2); /* SPICLK1 */

		bus_space_write_4(iot, gpioh, GPIO_PGCON, pgcon);

		/* Enable pull-up for pin 5, 6, and 7*/
		peup = bus_space_read_4(iot, gpioh, GPIO_PGUP);
		peup &= ~(1<<5);
		peup &= ~(1<<6);
		peup &= ~(1<<7);
		bus_space_write_4(iot, gpioh, GPIO_PGUP, peup);

	}

	bus_space_write_4(iot, sc->ioh, SPI_SPCON, mode);

	return 0;
}

int
s3c24x0_spi_master_send(struct ssspi_softc *sc, uint8_t value)
{
	sc->sc_received = FALSE;
	bus_space_write_1(sc->iot, sc->ioh, SPI_SPTDAT, value);

	return 0;
}

void
s3c24x0_spi_spin_wait(struct ssspi_softc *sc)
{
	uint32_t reg;
	do {
		reg = bus_space_read_4(sc->iot, sc->ioh, SPI_SPSTA);
	} while(! (reg & SPSTA_REDY));
}

int
s3c24x0_spi_wait(struct ssspi_softc *sc, uint8_t *valPtr)
{
#if 0
	uint32_t reg;
	do {
		reg = bus_space_read_4(sc->iot, sc->ioh, SPI_SPSTA);
	} while(!(reg & SPSTA_REDY));

#else
	mutex_enter(&sc->sc_intr_mtx);
	while( sc->sc_received == FALSE) {
		cv_wait(&sc->sc_intr_cv, &sc->sc_intr_mtx);
	}
	mutex_exit(&sc->sc_intr_mtx);
#endif

	if (valPtr != NULL) {
		//	*valPtr = bus_space_read_1(sc->iot, sc->ioh, SPI_SPRDAT);
		*valPtr = sc->sc_rxbyte;
	}

	return 0;
}

int
s3c24x0_spi_bps(struct ssspi_softc *sc, int bps)
{
	int pclk = s3c2xx0_softc->sc_pclk;
	int prescaler;

	if (bps > 1) {
		prescaler = pclk / 2 / bps - 1;

		if (prescaler <= 0 || 0xff < prescaler)
			return -1;
		bus_space_write_1(sc->iot, sc->ioh, SPI_SPPRE, prescaler);
	}

	return 0;
}

int
ssspi_intr(void *arg)
{
#if 1
	uint32_t reg;
	struct ssspi_softc *sc;

	sc = (struct ssspi_softc*)arg;

	reg = bus_space_read_4(sc->iot, sc->ioh, SPI_SPSTA);
	if (reg & SPSTA_REDY) {
		sc->sc_rxbyte = bus_space_read_1(sc->iot, sc->ioh, SPI_SPRDAT);

		mutex_enter(&sc->sc_intr_mtx);
		sc->sc_received = TRUE;
		cv_broadcast(&sc->sc_intr_cv);
		mutex_exit(&sc->sc_intr_mtx);
	}
#endif
	return 1;
}