1 | /* SPDX-License-Identifier: BSD-2-Clause */ |
---|
2 | |
---|
3 | /** |
---|
4 | * @file |
---|
5 | * |
---|
6 | * @ingroup RTEMSBSPsI386 |
---|
7 | * |
---|
8 | * @brief RTD316 driver interface defintions. |
---|
9 | */ |
---|
10 | |
---|
11 | /* |
---|
12 | * COPYRIGHT (c) 1989-2014. |
---|
13 | * On-Line Applications Research Corporation (OAR). |
---|
14 | * |
---|
15 | * Redistribution and use in source and binary forms, with or without |
---|
16 | * modification, are permitted provided that the following conditions |
---|
17 | * are met: |
---|
18 | * 1. Redistributions of source code must retain the above copyright |
---|
19 | * notice, this list of conditions and the following disclaimer. |
---|
20 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
21 | * notice, this list of conditions and the following disclaimer in the |
---|
22 | * documentation and/or other materials provided with the distribution. |
---|
23 | * |
---|
24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
27 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
---|
28 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
29 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
30 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
31 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
32 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
33 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
34 | * POSSIBILITY OF SUCH DAMAGE. |
---|
35 | */ |
---|
36 | |
---|
37 | #ifndef _BSP_RTD_316_h |
---|
38 | #define _BSP_RTD_316_h |
---|
39 | |
---|
40 | #ifdef __cplusplus |
---|
41 | extern "C" { |
---|
42 | #endif |
---|
43 | |
---|
44 | /** |
---|
45 | * This macro defines the standard device driver table entry for |
---|
46 | * a console device driver. |
---|
47 | */ |
---|
48 | #define RTD316_DRIVER_TABLE_ENTRY \ |
---|
49 | { rtd316_initialize, NULL, NULL, NULL, NULL, NULL } |
---|
50 | |
---|
51 | /** |
---|
52 | * @brief RTD316 Initialization Entry Point |
---|
53 | * |
---|
54 | * This method initializes the RTD316 device driver. |
---|
55 | * |
---|
56 | * @param[in] major is the device driver major number |
---|
57 | * @param[in] minor is the device driver minor number |
---|
58 | * @param[in] arg is the parameters to this call |
---|
59 | * |
---|
60 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
61 | * the device driver is successfully initialized. |
---|
62 | */ |
---|
63 | rtems_device_driver rtd316_initialize( |
---|
64 | rtems_device_major_number major, |
---|
65 | rtems_device_minor_number minor, |
---|
66 | void *arg |
---|
67 | ); |
---|
68 | |
---|
69 | /** |
---|
70 | * @brief RTD316 Obtain Register Helper |
---|
71 | * |
---|
72 | * This method is used to read registers on the RTD316. |
---|
73 | * |
---|
74 | * @param[in] addr is the base address |
---|
75 | * @param[in] reg is the register number |
---|
76 | * |
---|
77 | * @return This method returns the value of the register. |
---|
78 | */ |
---|
79 | uint8_t rtd316_com_get_register(uint32_t addr, uint8_t reg); |
---|
80 | |
---|
81 | /** |
---|
82 | * @brief RTD316 Set Register Helper |
---|
83 | * |
---|
84 | * This method is used to set registers on the RTD316. |
---|
85 | * |
---|
86 | * @param[in] addr is the base address |
---|
87 | * @param[in] reg is the register number |
---|
88 | */ |
---|
89 | void rtd316_com_set_register(uint32_t addr,uint8_t reg, uint8_t val); |
---|
90 | |
---|
91 | #ifdef __cplusplus |
---|
92 | } |
---|
93 | #endif |
---|
94 | |
---|
95 | #endif |
---|
96 | /* end of include file */ |
---|