nuttx-apps/examples/i2schar/i2schar.h
Fotis Panagiotopoulos bc5d8034f1 Typo fixes.
2022-01-06 10:30:41 +08:00

143 lines
4.7 KiB
C

/****************************************************************************
* apps/examples/i2schar/i2schar.h
*
* 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 __APPS_EXAMPLES_I2SCHAR_I2SCHAR_H
#define __APPS_EXAMPLES_I2SCHAR_I2SCHAR_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <pthread.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
/* CONFIG_EXAMPLES_I2SCHAR_DEVPATH - The default path to the I2S character
* device. Default: /dev/i2schar0
*/
#ifndef CONFIG_AUDIO_I2SCHAR
# error "I2S character device support is not enabled (CONFIG_AUDIO_I2SCHAR)"
#endif
#ifndef CONFIG_EXAMPLES_I2SCHAR_DEVPATH
# define CONFIG_EXAMPLES_I2SCHAR_DEVPATH "/dev/is2char0"
#endif
#ifdef CONFIG_EXAMPLES_I2SCHAR_TX
# ifndef CONFIG_EXAMPLES_I2SCHAR_TXBUFFERS
# define CONFIG_EXAMPLES_I2SCHAR_TXBUFFERS 4
# endif
# ifndef CONFIG_EXAMPLES_I2SCHAR_TXSTACKSIZE
# define CONFIG_EXAMPLES_I2SCHAR_TXSTACKSIZE 1536
# endif
#else
# undef CONFIG_EXAMPLES_I2SCHAR_TXBUFFERS
# define CONFIG_EXAMPLES_I2SCHAR_TXBUFFERS 0
#endif
#ifdef CONFIG_EXAMPLES_I2SCHAR_RX
# ifndef CONFIG_EXAMPLES_I2SCHAR_RXBUFFERS
# define CONFIG_EXAMPLES_I2SCHAR_RXBUFFERS 4
# endif
# ifndef CONFIG_EXAMPLES_I2SCHAR_RXSTACKSIZE
# define CONFIG_EXAMPLES_I2SCHAR_RXSTACKSIZE 1536
# endif
#else
# undef CONFIG_EXAMPLES_I2SCHAR_RXBUFFERS
# define CONFIG_EXAMPLES_I2SCHAR_RXBUFFERS 0
#endif
#ifndef CONFIG_EXAMPLES_I2SCHAR_BUFSIZE
# efine CONFIG_EXAMPLES_I2SCHAR_BUFSIZE 256
#endif
/****************************************************************************
* Public Types
****************************************************************************/
struct i2schar_state_s
{
bool initialized;
FAR char *devpath;
#ifdef CONFIG_EXAMPLES_I2SCHAR_TX
int txcount;
#endif
#ifdef CONFIG_EXAMPLES_I2SCHAR_RX
int rxcount;
#endif
};
/****************************************************************************
* Public Data
****************************************************************************/
extern struct i2schar_state_s g_i2schar;
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: i2schar_devinit()
*
* Description:
* Perform architecture-specific initialization of the I2s hardware and
* registration of the I2S character driver CHAR hardware. If
* CONFIG_EXAMPLES_I2SCHAR_DEVINIT is defined, then board-specific logic
* must provide this function.
*
****************************************************************************/
#ifdef CONFIG_EXAMPLES_I2SCHAR_DEVINIT
int i2schar_devinit(void);
#endif
/****************************************************************************
* Name: i2schar_transmitter()
*
* Description:
* This is the entry point for the transmitter thread.
*
****************************************************************************/
#ifdef CONFIG_EXAMPLES_I2SCHAR_TX
pthread_addr_t i2schar_transmitter(pthread_addr_t arg);
#endif
/****************************************************************************
* Name: i2schar_receiver()
*
* Description:
* This is the entry point for the receiver thread.
*
****************************************************************************/
#ifdef CONFIG_EXAMPLES_I2SCHAR_RX
pthread_addr_t i2schar_receiver(pthread_addr_t arg);
#endif
#endif /* __APPS_EXAMPLES_I2SCHAR_I2SCHAR_H */