mirror of
https://github.com/apache/nuttx.git
synced 2026-06-07 01:05:54 +08:00
drivers/rmt: Implement an upper-half RMT character driver
The RMT (Remote Control) character driver allows to use the RMT peripheral (usually, a one-wire peripheral dedicated to driving IR remote control) as a character driver. Please note that this perpiheral depends on the lower-half specific driver implementation.
This commit is contained in:
Tiago Medicci Serrano
committed by
Xiang Xiao
Xiang Xiao
parent
dec6ec1138
commit
fcff5d43b7
@@ -202,7 +202,7 @@ size_t circbuf_space(FAR struct circbuf_s *circ);
|
||||
* Name: circbuf_peekat
|
||||
*
|
||||
* Description:
|
||||
* Get data speicified position from the circular buffer without removing
|
||||
* Get data specified position from the circular buffer without removing
|
||||
*
|
||||
* Note :
|
||||
* That with only one concurrent reader and one concurrent writer,
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
/****************************************************************************
|
||||
* include/nuttx/rmt/rmt.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 __INCLUDE_NUTTX_RMT_RMT_H
|
||||
#define __INCLUDE_NUTTX_RMT_RMT_H
|
||||
|
||||
/****************************************************************************
|
||||
* Included Files
|
||||
****************************************************************************/
|
||||
|
||||
#include <nuttx/config.h>
|
||||
|
||||
#include <sys/types.h>
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifdef CONFIG_RMT
|
||||
|
||||
/****************************************************************************
|
||||
* Pre-processor Definitions
|
||||
****************************************************************************/
|
||||
|
||||
/****************************************************************************
|
||||
* Public Types
|
||||
****************************************************************************/
|
||||
|
||||
struct rmt_dev_s;
|
||||
|
||||
/* The RMT peripheral vtable */
|
||||
|
||||
struct rmt_ops_s
|
||||
{
|
||||
CODE int (*open)(FAR struct rmt_dev_s *dev);
|
||||
CODE int (*close)(FAR struct rmt_dev_s *dev);
|
||||
CODE ssize_t (*write)(FAR struct rmt_dev_s *dev,
|
||||
FAR const char *buffer,
|
||||
size_t buflen);
|
||||
CODE ssize_t (*read)(FAR struct rmt_dev_s *dev,
|
||||
FAR char *buffer,
|
||||
size_t buflen);
|
||||
};
|
||||
|
||||
/* RMT private data. This structure only defines the initial fields of the
|
||||
* structure visible to the RMT client. The specific implementation may
|
||||
* add additional, device-specific fields.
|
||||
*/
|
||||
|
||||
struct rmt_dev_s
|
||||
{
|
||||
FAR const struct rmt_ops_s *ops;
|
||||
FAR struct circbuf_s *circbuf;
|
||||
sem_t *recvsem;
|
||||
int minor;
|
||||
};
|
||||
|
||||
/****************************************************************************
|
||||
* Public Data
|
||||
****************************************************************************/
|
||||
|
||||
#undef EXTERN
|
||||
#if defined(__cplusplus)
|
||||
#define EXTERN extern "C"
|
||||
extern "C"
|
||||
{
|
||||
#else
|
||||
#define EXTERN extern
|
||||
#endif
|
||||
|
||||
/****************************************************************************
|
||||
* Public Functions Prototypes
|
||||
****************************************************************************/
|
||||
|
||||
#undef EXTERN
|
||||
#if defined(__cplusplus)
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* CONFIG_RMT */
|
||||
#endif /* __INCLUDE_NUTTX_RMT_RMT_H */
|
||||
@@ -0,0 +1,92 @@
|
||||
/****************************************************************************
|
||||
* include/nuttx/rmt/rmtchar.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 __INCLUDE_NUTTX_RMT_RMTCHAR_H
|
||||
#define __INCLUDE_NUTTX_RMT_RMTCHAR_H
|
||||
|
||||
/****************************************************************************
|
||||
* Included Files
|
||||
****************************************************************************/
|
||||
|
||||
#include <nuttx/config.h>
|
||||
|
||||
#include <sys/types.h>
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include <nuttx/rmt/rmt.h>
|
||||
|
||||
#ifdef CONFIG_RMTCHAR
|
||||
|
||||
/****************************************************************************
|
||||
* Pre-processor Definitions
|
||||
****************************************************************************/
|
||||
|
||||
/****************************************************************************
|
||||
* Public Types
|
||||
****************************************************************************/
|
||||
|
||||
/****************************************************************************
|
||||
* Public Data
|
||||
****************************************************************************/
|
||||
|
||||
#undef EXTERN
|
||||
#if defined(__cplusplus)
|
||||
#define EXTERN extern "C"
|
||||
extern "C"
|
||||
{
|
||||
#else
|
||||
#define EXTERN extern
|
||||
#endif
|
||||
|
||||
/****************************************************************************
|
||||
* Public Functions Prototypes
|
||||
****************************************************************************/
|
||||
|
||||
/****************************************************************************
|
||||
* Name: rmtchar_register
|
||||
*
|
||||
* Description:
|
||||
* Create and register the RMT character driver.
|
||||
*
|
||||
* The RMT character driver is a simple character driver that supports RMT
|
||||
* transfers via read() and write(). This driver is primarily intended to
|
||||
* support RMT testing. It is not suitable for use in any real driver
|
||||
* application in its current form because its buffer management heuristics
|
||||
* are dependent on the lower half driver (device-specific).
|
||||
*
|
||||
* Input Parameters:
|
||||
* rmt - An instance of the lower half RMT driver
|
||||
*
|
||||
* Returned Value:
|
||||
* OK if the driver was successfully registered; A negated errno value is
|
||||
* returned on any failure.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
int rmtchar_register(FAR struct rmt_dev_s *rmt);
|
||||
|
||||
#undef EXTERN
|
||||
#if defined(__cplusplus)
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* CONFIG_RMT */
|
||||
#endif /* __INCLUDE_NUTTX_RMT_RMTCHAR_H */
|
||||
Reference in New Issue
Block a user