forked from nuttx/nuttx-update
cd2fcf5252
Most tools used for compliance and SBOM generation use SPDX identifiers This change brings us a step closer to an easy SBOM generation. Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
191 lines
5.7 KiB
C
191 lines
5.7 KiB
C
/****************************************************************************
|
|
* include/nuttx/audio/es8311.h
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_AUDIO_ES8311_H
|
|
#define __INCLUDE_NUTTX_AUDIO_ES8311_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#include <nuttx/irq.h>
|
|
|
|
#ifdef CONFIG_AUDIO_ES8311
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Configuration ************************************************************
|
|
*
|
|
* CONFIG_AUDIO_ES8311 - Enables ES8311 support
|
|
* CONFIG_ES8311_INITVOLUME - The initial volume level
|
|
* in the range {0..1000}
|
|
* CONFIG_ES8311_INFLIGHT - Maximum number of buffers that the ES8311
|
|
* driver will send to the I2S driver before any have completed.
|
|
* CONFIG_ES8311_MSG_PRIO - Priority of messages sent to the ES8311
|
|
* worker thread.
|
|
* CONFIG_ES8311_BUFFER_SIZE - Preferred buffer size
|
|
* CONFIG_ES8311_NUM_BUFFERS - Preferred number of buffers
|
|
* CONFIG_ES8311_WORKER_STACKSIZE - Stack size to use when creating the the
|
|
* ES8311 worker thread.
|
|
* CONFIG_ES8311_REGDUMP - Enable logic to dump all ES8311 registers to
|
|
* the SYSLOG device.
|
|
*/
|
|
|
|
/* Pre-requisites */
|
|
|
|
#ifndef CONFIG_AUDIO
|
|
# error CONFIG_AUDIO is required for audio subsystem support
|
|
#endif
|
|
|
|
#ifndef CONFIG_I2S
|
|
# error CONFIG_I2S is required by the ES8311 driver
|
|
#endif
|
|
|
|
#ifndef CONFIG_I2C
|
|
# error CONFIG_I2C is required by the ES8311 driver
|
|
#endif
|
|
|
|
#ifndef CONFIG_SCHED_WORKQUEUE
|
|
# error CONFIG_SCHED_WORKQUEUE is required by the ES8311 driver
|
|
#endif
|
|
|
|
/* Default configuration values */
|
|
|
|
#ifndef CONFIG_ES8311_INPUT_INITVOLUME
|
|
# define CONFIG_ES8311_INPUT_INITVOLUME 1000
|
|
#endif
|
|
|
|
#ifndef CONFIG_ES8311_OUTPUT_INITVOLUME
|
|
# define CONFIG_ES8311_OUTPUT_INITVOLUME 400
|
|
#endif
|
|
|
|
#ifndef CONFIG_ES8311_INFLIGHT
|
|
# define CONFIG_ES8311_INFLIGHT 2
|
|
#endif
|
|
|
|
#if CONFIG_ES8311_INFLIGHT > 255
|
|
# error CONFIG_ES8311_INFLIGHT must fit in a uint8_t
|
|
#endif
|
|
|
|
#ifndef CONFIG_ES8311_MSG_PRIO
|
|
# define CONFIG_ES8311_MSG_PRIO 1
|
|
#endif
|
|
|
|
#ifndef CONFIG_ES8311_BUFFER_SIZE
|
|
# define CONFIG_ES8311_BUFFER_SIZE 4096
|
|
#endif
|
|
|
|
#ifndef CONFIG_ES8311_NUM_BUFFERS
|
|
# define CONFIG_ES8311_NUM_BUFFERS 4
|
|
#endif
|
|
|
|
#ifndef CONFIG_ES8311_WORKER_STACKSIZE
|
|
# define CONFIG_ES8311_WORKER_STACKSIZE 2048
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
struct es8311_lower_s
|
|
{
|
|
/* I2C characterization */
|
|
|
|
uint32_t frequency; /* Initial I2C frequency */
|
|
uint8_t address; /* 7-bit I2C address (only bits 0-6 used) */
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: es8311_initialize
|
|
*
|
|
* Description:
|
|
* Initialize the ES8311 device.
|
|
*
|
|
* Input Parameters:
|
|
* i2c - An I2C driver instance;
|
|
* i2s - An I2S driver instance;
|
|
* lower - Persistent board configuration data.
|
|
*
|
|
* Returned Value:
|
|
* A new lower half audio interface for the ES8311 device is returned on
|
|
* success; NULL is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
struct i2c_master_s;
|
|
struct i2s_dev_s;
|
|
struct audio_lowerhalf_s;
|
|
|
|
FAR struct audio_lowerhalf_s *
|
|
es8311_initialize(FAR struct i2c_master_s *i2c,
|
|
FAR struct i2s_dev_s *i2s,
|
|
FAR const struct es8311_lower_s *lower);
|
|
|
|
/****************************************************************************
|
|
* Name: es8311_dump_registers
|
|
*
|
|
* Description:
|
|
* Dump the contents of all ES8311 registers to the syslog device
|
|
*
|
|
* Input Parameters:
|
|
* dev - The device instance returned by es8311_initialize
|
|
*
|
|
* Returned Value:
|
|
* None.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ES8311_REGDUMP
|
|
void es8311_dump_registers(FAR struct audio_lowerhalf_s *dev,
|
|
FAR const char *msg);
|
|
#else
|
|
# define es8311_dump_registers(d,m)
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* CONFIG_AUDIO_ES8311 */
|
|
#endif /* __INCLUDE_NUTTX_AUDIO_ES8311_H */
|