You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ma...@apache.org on 2016/08/24 18:56:03 UTC

[02/14] incubator-mynewt-core git commit: UART driver interface; first take

UART driver interface; first take


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/commit/6e7d8916
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/tree/6e7d8916
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/diff/6e7d8916

Branch: refs/heads/sterly_refactor
Commit: 6e7d8916e2248f2783a8b36963c442237d08b560
Parents: a80d2cd
Author: Marko Kiiskila <ma...@runtime.io>
Authored: Tue Aug 23 15:30:06 2016 -0700
Committer: Marko Kiiskila <ma...@runtime.io>
Committed: Tue Aug 23 15:30:06 2016 -0700

----------------------------------------------------------------------
 drivers/uart/include/uart/uart.h | 103 ++++++++++++++++++++++++++++++++++
 drivers/uart/pkg.yml             |  28 +++++++++
 drivers/uart/src/uart.c          |  18 ++++++
 3 files changed, 149 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/6e7d8916/drivers/uart/include/uart/uart.h
----------------------------------------------------------------------
diff --git a/drivers/uart/include/uart/uart.h b/drivers/uart/include/uart/uart.h
new file mode 100644
index 0000000..4be0d22
--- /dev/null
+++ b/drivers/uart/include/uart/uart.h
@@ -0,0 +1,103 @@
+/**
+ * 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 __DRIVERS_UART_H_
+#define __DRIVERS_UART_H_
+
+#include <inttypes.h>
+#include <os/os_dev.h>
+
+struct uart_dev;
+
+/*
+ * Function prototype for UART driver to ask for more data to send.
+ * Returns -1 if no more data is available for TX.
+ * Driver must call this with interrupts disabled.
+ */
+typedef int (*uart_tx_char)(void *arg);
+
+/*
+ * Function prototype for UART driver to report that transmission is
+ * complete. This should be called when transmission of last byte is
+ * finished.
+ * Driver must call this with interrupts disabled.
+ */
+typedef void (*uart_tx_done)(void *arg);
+
+/*
+ * Function prototype for UART driver to report incoming byte of data.
+ * Returns -1 if data was dropped.
+ * Driver must call this with interrupts disabled.
+ */
+typedef int (*uart_rx_char)(void *arg, uint8_t byte);
+
+struct uart_driver_funcs {
+    void (*uf_start_tx)(struct uart_dev *);
+    void (*uf_start_rx)(struct uart_dev *);
+    void (*uf_blocking_tx)(struct uart_dev *, uint8_t);
+};
+
+struct uart_dev {
+    struct os_dev ud_dev;
+    struct uart_driver_funcs ud_funcs;
+    void *ud_priv;
+};
+
+enum uart_parity {
+    UART_PARITY_NONE = 0,       /* no parity */
+    UART_PARITY_ODD = 1,        /* odd parity bit */
+    UART_PARITY_EVEN = 2        /* even parity bit */
+};
+
+enum uart_flow_ctl {
+    UART_FLOW_CTL_NONE = 0,     /* no flow control */
+    UART_FLOW_CTL_RTS_CTS = 1   /* RTS/CTS */
+};
+
+struct uart_conf {
+    uint32_t uc_speed;          /* baudrate in bps */
+    uint8_t uc_databits;        /* number of data bits */
+    uint8_t uc_stopbits;        /* number of stop bits */
+    enum uart_parity uc_parity;
+    enum uart_flow_ctl uc_flow_ctl;
+    uart_tx_char uc_tx_char;
+    uart_rx_char uc_rx_char;
+    uart_tx_done uc_tx_done;
+    void *uc_cb_arg;
+};
+
+static inline void
+uart_start_tx(struct uart_dev *dev)
+{
+    dev->ud_funcs.uf_start_tx(dev);
+}
+
+static inline void
+uart_start_rx(struct uart_dev *dev)
+{
+    dev->ud_funcs.uf_start_rx(dev);
+}
+
+static inline void
+uart_blocking_tx(struct uart_dev *dev, uint8_t byte)
+{
+    dev->ud_funcs.uf_blocking_tx(dev, byte);
+}
+
+#endif /* __DRIVERS_UART_H_ */

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/6e7d8916/drivers/uart/pkg.yml
----------------------------------------------------------------------
diff --git a/drivers/uart/pkg.yml b/drivers/uart/pkg.yml
new file mode 100644
index 0000000..ce6eb6a
--- /dev/null
+++ b/drivers/uart/pkg.yml
@@ -0,0 +1,28 @@
+#
+# 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.
+#
+
+pkg.name: drivers/uart
+pkg.description: UART driver interfaces
+pkg.author: "Apache Mynewt <de...@mynewt.incubator.apache.org>"
+pkg.homepage: "http://mynewt.apache.org/"
+pkg.keywords:
+pkg.deps:
+pkg.req_apis: 
+    - UART_HW_IMPL
+

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/6e7d8916/drivers/uart/src/uart.c
----------------------------------------------------------------------
diff --git a/drivers/uart/src/uart.c b/drivers/uart/src/uart.c
new file mode 100644
index 0000000..f736fe1
--- /dev/null
+++ b/drivers/uart/src/uart.c
@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */