RTEMS 6.1-rc5
Loading...
Searching...
No Matches
grascs.h
1/* SPDX-License-Identifier: BSD-2-Clause */
2
3/*
4 * Header file for GRASCS RTEMS driver
5 *
6 * COPYRIGHT (c) 2008.
7 * Cobham Gaisler AB.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef __GRASCS_H__
32#define __GRASCS_H__
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/* Minimum and maximum system frequency */
39#define GRASCS_MIN_SFREQ 10000
40#define GRASCS_MAX_SFREQ 255000
41
42/* Default, minimum and maximum ETR pulse frequency */
43#define GRASCS_DEFAULT_ETRFREQ 10
44#define GRASCS_MIN_ETRFREQ 1
45#define GRASCS_MAX_ETRFREQ 100
46
47/* Maximum number of external time markers */
48#define GRASCS_MAX_TMS 6
49
50/* Error codes */
51#define GRASCS_ERROR_STARTSTOP 1 /* Serial/synch interface is running/stopped */
52#define GRASCS_ERROR_TRANSACTIVE 2 /* Busy with transaction */
53#define GRASCS_ERROR_CAPFAULT 3 /* Core capabilities prohibit request */
54
55/* Command register */
56#define GRASCS_CMD_RESET (1 << 0)
57#define GRASCS_CMD_STARTSTOP (1 << 1)
58#define GRASCS_CMD_ESTARTSTOP (1 << 2)
59#define GRASCS_CMD_SENDTM (1 << 3)
60#define GRASCS_CMD_ETRCTRL (7 << 4)
61#define GRASCS_CMD_ETRCTRL_BITS 4
62#define GRASCS_CMD_SLAVESEL (15 << 8)
63#define GRASCS_CMD_SLAVESEL_BITS 8
64#define GRASCS_CMD_TCDONE (1 << 12)
65#define GRASCS_CMD_TMDONE (1 << 13)
66#define GRASCS_CMD_US1 (255 << 16)
67#define GRASCS_CMD_US1_BITS 16
68#define GRASCS_CMD_US1C (1 << 24)
69
70/* Clock scale register */
71#define GRASCS_CLK_ETRFREQ_BITS 12
72
73/* Status register */
74#define GRASCS_STS_RUNNING (1 << 0)
75#define GRASCS_STS_ERUNNING (1 << 1)
76#define GRASCS_STS_TCDONE (1 << 4)
77#define GRASCS_STS_TMDONE (1 << 5)
78#define GRASCS_STS_DBITS_BITS 8
79#define GRASCS_STS_NSLAVES_BITS 13
80#define GRASCS_STS_USCONF_BITS 18
81#define GRASCS_STS_TMCONF_BITS 19
82
83extern int ASCS_init(void);
84
85extern int ASCS_input_select(int slave);
86
87extern int ASCS_etr_select(int etr, int freq);
88
89extern void ASCS_start(void);
90
91extern void ASCS_stop(void);
92
93extern int ASCS_iface_status(void);
94
95extern int ASCS_TC_send(int *word);
96
97extern int ASCS_TC_send_block(int *block, int ntrans);
98
99extern void ASCS_TC_sync_start(void);
100
101extern void ASCS_TC_sync_stop(void);
102
103extern int ASCS_TM_recv(int *word);
104
105extern int ASCS_TM_recv_block(int *block, int ntrans);
106
107#ifdef __cplusplus
108}
109#endif
110
111#endif
Generated by doxygen 1.9.6