aboutsummaryrefslogtreecommitdiffstats
path: root/firmware/microblaze/lib/hal_io.h
blob: f8ec617f87b806173aaf761324f307c6ed94edaa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* -*- c++ -*- */
/*
 * Copyright 2007 Free Software Foundation, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef INCLUDED_HAL_IO_H
#define INCLUDED_HAL_IO_H

#include "memory_map.h"

void hal_io_init(void);
void hal_finish();


/*
 * ------------------------------------------------------------------------
 * The GPIO pins are organized into two banks of 16-bits.
 * Bank 0 goes to the Tx daughterboard, Bank 1 goes to the Rx daughterboard.
 *
 * Each pin may be configured as an input or an output from the FPGA.
 * For output pins, there are four signals which may be routed to the
 * pin.  The four signals are the value written by s/w, the output of
 * the ATR controller, or two different sources of debug info from the
 * FPGA fabric.
 * ------------------------------------------------------------------------
 */

#define GPIO_TX_BANK	0	// pins that connect to the Tx daughterboard
#define	GPIO_RX_BANK	1	// pins that connect to the Rx daughterboard


/*!
 * \brief Set the data direction for GPIO pins
 *
 * If the bit is set, it's an output from the FPGA.
 * \param value is a 16-bit bitmask of values
 * \param mask is a 16-bit bitmask of which bits to effect.
 */ 
void hal_gpio_set_ddr(int bank, int value, int mask);

/*!
 * \brief Select the source of the signal for an output pin.
 *
 * \param code is is one of 's', 'a', '0', '1'
 *   where 's' selects software output, 'a' selects ATR output, '0' selects
 *   debug 0, '1' selects debug 1.
 */
void hal_gpio_set_sel(int bank, int bitno, char code);

/*!
 * \brief Select the source of the signal for the output pins.
 *
 * \param codes is is a string of 16 characters composed of '.', 's',
 * 'a', '0', or '1' where '.' means "don't change", 's' selects
 * software output, 'a' selects ATR output, '0' selects debug 0, '1'
 * selects debug 1.
 */
void hal_gpio_set_sels(int bank, char *codes);


/*!
 * \brief write \p value to gpio pins specified by \p mask.
 */
void hal_gpio_write(int bank, int value, int mask);

/*!
 * \brief read GPIO bits
 */
int  hal_gpio_read(int bank);


/*
 * ------------------------------------------------------------------------
 *			   control the leds
 *
 * Low 4-bits are the general purpose leds on the board
 * The next bit is the led on the ethernet connector
 * ------------------------------------------------------------------------
 */

void hal_set_leds(int value, int mask);
void hal_set_led_src(int value, int mask);
void hal_toggle_leds(int mask);

/*
 * ------------------------------------------------------------------------
 *			   simple timeouts
 * ------------------------------------------------------------------------
 */



static inline void
hal_set_timeout(int delta_ticks)
{
  sr_simple_timer->onetime = delta_ticks;
}

/*
 * ------------------------------------------------------------------------
 *			interrupt enable/disable
 * ------------------------------------------------------------------------
 */

/*!
 * \brief Disable interrupts and return previous interrupt enable state.
 * [Microblaze specific]
 */
static inline int
hal_disable_ints(void)
{
  int result, t0;

  asm volatile("mfs   %0, rmsr       \n\
		andni %1, %0, 0x2    \n\
		mts   rmsr, %1"
	       : "=r" (result), "=r" (t0));
  return result;
}

/*!
 * \brief Enable interrupts and return previous interrupt enable state.
 * [Microblaze specific]
 */
static inline int
hal_enable_ints(void)
{
  int result, t0;

  asm volatile("mfs  %0, rmsr	      \n\
		ori  %1, %0, 0x2      \n\
		mts  rmsr, %1"
	       : "=r" (result), "=r" (t0));
  return result;
}

/*!
 * \brief Set interrupt enable state to \p prev_state.
 * [Microblaze specific]
 */
static inline void
hal_restore_ints(int prev_state)
{
  int t0, t1;
  asm volatile("andi  %0, %2, 0x2	\n\
		mfs   %1, rmsr          \n\
		andni %1, %1, 0x2	\n\
		or    %1, %1, %0	\n\
		mts   rmsr, %1"
	       : "=r" (t0), "=r"(t1) : "r" (prev_state));
}

#endif /* INCLUDED_HAL_IO_H */