dai: simple i/f to control flow between platform and lib

A mechanism similar to the one used for dma applied.
Dai initialization moved to separate unit from the main platform
code for cavs.
Optional dynamic discovery and initialization possible before
making available to other fw units via the lib hub.
SSP count cleaned up for cavs (important pre-work
for clock gating).

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>

Author: Marcin Maka

src/arch/xtensa/Makefile.am

@@ -93,6 +93,7 @@ sof_LDADD = \
 	../../platform/$(PLATFORM)/libplatform.la \
 	../../ipc/libsof_ipc.a \
 	../../lib/libdma.a \
+	../../lib/libdai.a \
 	../../audio/libaudio.a \
 	../../drivers/libdrivers.la \
 	../../math/libsof_math.a \

src/include/sof/dai.h

@@ -125,6 +125,31 @@ struct dai {
 	uint32_t private_size;
 };
 
+/**
+ * \brief Array of DAIs grouped by type.
+ */
+struct dai_type_info {
+	uint32_t type;		/**< Type */
+	struct dai *dai_array;	/**< Array of DAIs */
+	size_t num_dais;	/**< Number of elements in dai_array */
+};
+
+/**
+ * \brief Plugs platform specific DAI array once initialized into the lib.
+ *
+ * Lib serves the DAIs to other FW elements with dai_get()
+ *
+ * \param[in] dai_type_array Array of DAI arrays grouped by type.
+ * \param[in] num_dai_types Number of elements in the dai_type_array.
+ */
+void dai_install(struct dai_type_info *dai_type_array, size_t num_dai_types);
+
+/**
+ * \brief API to request a platform DAI.
+ *
+ * \param[in] type Type of requested DAI.
+ * \param[in] index Index of requested DAI.
+ */
 struct dai *dai_get(uint32_t type, uint32_t index);
 
 #define dai_set_drvdata(dai, data) \

src/lib/Makefile.am

@@ -1,4 +1,4 @@
-noinst_LIBRARIES = libcore.a libdma.a
+noinst_LIBRARIES = libcore.a libdma.a libdai.a
 
 libcore_a_SOURCES = \
 	lib.c \
@@ -28,3 +28,13 @@ libdma_a_CFLAGS = \
 	$(ARCH_INCDIR) \
 	$(PLATFORM_INCDIR) \
 	$(SOF_INCDIR)
+
+libdai_a_SOURCES = \
+	dai.c
+
+libdai_a_CFLAGS = \
+	$(AM_CFLAGS) \
+	$(ARCH_CFLAGS) \
+	$(ARCH_INCDIR) \
+	$(PLATFORM_INCDIR) \
+	$(SOF_INCDIR)

src/lib/dai.c

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2018, Intel Corporation
+ * 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 the Intel Corporation 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 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
+ *
+ * Author: Marcin Maka <marcin.maka@linux.intel.com>
+ */
+
+#include <sof/dai.h>
+
+struct dai_info {
+	struct dai_type_info *dai_type_array;
+	size_t num_dai_types;
+};
+
+static struct dai_info lib_dai = {
+	.dai_type_array = NULL,
+	.num_dai_types = 0
+};
+
+void dai_install(struct dai_type_info *dai_type_array, size_t num_dai_types)
+{
+	lib_dai.dai_type_array = dai_type_array;
+	lib_dai.num_dai_types = num_dai_types;
+}
+
+struct dai *dai_get(uint32_t type, uint32_t index)
+{
+	int i;
+	struct dai_type_info *dti;
+
+	for (dti = lib_dai.dai_type_array;
+	     dti < lib_dai.dai_type_array + lib_dai.num_dai_types; dti++) {
+		if (dti->type == type) {
+			for (i = 0; i < dti->num_dais; i++) {
+				if (dti->dai_array[i].index == index)
+					return dti->dai_array + i;
+			}
+		}
+	}
+	return NULL;
+}

src/platform/apollolake/include/platform/dai.h

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2018, Intel Corporation
+ * 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 the Intel Corporation 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 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
+ *
+ * Author: Marcin Maka <marcin.maka@linux.intel.com>
+ */
+
+#ifndef __PLATFORM_DAI_H__
+#define __PLATFORM_DAI_H__
+
+/* SSP */
+
+/*
+ * Number of base and extended SSP ports must be defined separately
+ * since some HW registers are in two groups, one for base and one
+ * for extended.
+ */
+
+/** \brief Number of 'base' SSP ports available */
+#define DAI_NUM_SSP_BASE	4
+
+/** \brief Number of 'extended' SSP ports available */
+#define DAI_NUM_SSP_EXT		2
+
+int dai_init(void);
+
+#endif

src/platform/apollolake/include/platform/platform.h

@@ -130,9 +130,6 @@ struct sof;
 /* platform has low power memory type */
 #define PLATFORM_MEM_HAS_LP_RAM
 
-/* number of SSP ports in platform */
-#define PLATFORM_NUM_SSP	6
-
 /* DSP default delay in cycles */
 #define PLATFORM_DEFAULT_DELAY	12
 

src/platform/baytrail/dai.c

@@ -36,6 +36,7 @@
 #include <platform/memory.h>
 #include <platform/interrupt.h>
 #include <platform/dma.h>
+#include <platform/dai.h>
 #include <uapi/ipc.h>
 #include <stdint.h>
 #include <string.h>
@@ -148,14 +149,16 @@ static struct dai ssp[] = {
 #endif
 };
 
-struct dai *dai_get(enum sof_ipc_dai_type type, uint32_t index)
-{
-	int i;
-
-	for (i = 0; i < ARRAY_SIZE(ssp); i++) {
-		if (ssp[i].type == type && ssp[i].index == index)
-			return &ssp[i];
+static struct dai_type_info dti[] = {
+	{
+		.type = SOF_DAI_INTEL_SSP,
+		.dai_array = ssp,
+		.num_dais = ARRAY_SIZE(ssp)
 	}
+};
 
-	return NULL;
+int dai_init(void)
+{
+	dai_install(dti, ARRAY_SIZE(dti));
+	return 0;
 }

src/platform/baytrail/include/platform/dai.h

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2018, Intel Corporation
+ * 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 the Intel Corporation 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 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
+ *
+ * Author: Marcin Maka <marcin.maka@linux.intel.com>
+ */
+
+#ifndef __PLATFORM_DAI_H__
+#define __PLATFORM_DAI_H__
+
+int dai_init(void);
+
+#endif

src/platform/baytrail/platform.c

@@ -33,6 +33,7 @@
 #include <platform/mailbox.h>
 #include <platform/shim.h>
 #include <platform/dma.h>
+#include <platform/dai.h>
 #include <platform/clk.h>
 #include <platform/timer.h>
 #include <platform/pmc.h>
@@ -234,6 +235,10 @@ int platform_init(struct sof *sof)
 	if (ret < 0)
 		return -ENODEV;
 
+	ret = dai_init();
+	if (ret < 0)
+		return -ENODEV;
+
 	/* mask SSP 0 - 2 interrupts */
 	shim_write(SHIM_PIMR, shim_read(SHIM_PIMR) | 0x00000038);
 

src/platform/cannonlake/include/platform/dai.h

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2018, Intel Corporation
+ * 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 the Intel Corporation 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 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
+ *
+ * Author: Marcin Maka <marcin.maka@linux.intel.com>
+ */
+
+#ifndef __PLATFORM_DAI_H__
+#define __PLATFORM_DAI_H__
+
+/* SSP */
+
+/*
+ * Number of base and extended SSP ports must be defined separately
+ * since some HW registers are in two groups, one for base and one
+ * for extended.
+ */
+
+/** \brief Number of 'base' SSP ports available */
+#define DAI_NUM_SSP_BASE	3
+
+/** \brief Number of 'extended' SSP ports available */
+#define DAI_NUM_SSP_EXT		0
+
+int dai_init(void);
+
+#endif