aboutsummaryrefslogtreecommitdiffstats
path: root/libraries/openieee/v08/std_logic_1164.vhdl
blob: 8df4cdcde1e0166dfc20eee2af7fe784ef5077bb (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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
--  This is an implementation of -*- vhdl -*- ieee.std_logic_1164 based only
--  on the specifications.  This file is part of GHDL.
--  Copyright (C) 2015 Tristan Gingold
--
--  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 2 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 <gnu.org/licenses>.

use std.textio.all;

package std_logic_1164 is

  --  Unresolved logic state.
  type std_ulogic is
    (
     'U',  --  Uninitialized, this is also the default value.
     'X',  --  Unknown / conflict value (forcing level).
     '0',  --  0 (forcing level).
     '1',  --  1 (forcing level).
     'Z',  --  High impedance.
     'W',  --  Unknown / conflict (weak level).
     'L',  --  0 (weak level).
     'H',  --  1 (weak level).
     '-'   --  Don't care.
    );

  --  Vector of logic state.
  type std_ulogic_vector is array (natural range <>) of std_ulogic;

  --  Resolution function.
  --  If S is empty, returns 'Z'.
  --  If S has one element, return the element.
  --  Otherwise, 'U' is the strongest.
  --       then  'X'
  --       then  '0' and '1'
  --       then  'W'
  --       then  'H' and 'L'
  --       then  'Z'.
  function resolved (s : std_ulogic_vector) return std_ulogic;

  --  Resolved logic state.
  subtype std_logic is resolved std_ulogic;

  --  Vector of std_logic.
  subtype std_logic_vector is (resolved) std_ulogic_vector;

  --  Subtypes of std_ulogic.  The names give the values.
  subtype X01   is resolved std_ulogic range 'X' to '1';
  subtype X01Z  is resolved std_ulogic range 'X' to 'Z';
  subtype UX01  is resolved std_ulogic range 'U' to '1';
  subtype UX01Z is resolved std_ulogic range 'U' to 'Z';

  --  Logical operators.
  --  For logical operations, the inputs are first normalized to UX01:
  --  0 and L are normalized to 0, 1 and 1 are normalized to 1, U isnt changed,
  --  all other states are normalized to X.
  --  Then the classical electric rules are followed.
  function "and"  (l : std_ulogic; r : std_ulogic) return UX01;
  function "nand" (l : std_ulogic; r : std_ulogic) return UX01;
  function "or"   (l : std_ulogic; r : std_ulogic) return UX01;
  function "nor"  (l : std_ulogic; r : std_ulogic) return UX01;
  function "xor"  (l : std_ulogic; r : std_ulogic) return UX01;
  function "xnor" (l : std_ulogic; r : std_ulogic) return UX01;
  function "not"  (l : std_ulogic) return UX01;

  --  Logical operators for vectors.
  --  An assertion of severity failure fails if the length of L and R aren't
  --  equal.  The result range is 1 to L'Length.

  function "and"  (l, r : std_ulogic_vector) return std_ulogic_vector;
  function "nand" (l, r : std_ulogic_vector) return std_ulogic_vector;
  function "or"   (l, r : std_ulogic_vector) return std_ulogic_vector;
  function "nor"  (l, r : std_ulogic_vector) return std_ulogic_vector;
  function "xor"  (l, r : std_ulogic_vector) return std_ulogic_vector;
  function "xnor" (l, r : std_ulogic_vector) return std_ulogic_vector;
  function "not"  (l : std_ulogic_vector) return std_ulogic_vector;

  function "and"  (l : std_ulogic_vector; r : std_ulogic       )
    return std_ulogic_vector;
  function "and"  (l : std_ulogic;        r : std_ulogic_vector)
    return std_ulogic_vector;
  function "nand" (l : std_ulogic_vector; r : std_ulogic       )
    return std_ulogic_vector;
  function "nand" (l : std_ulogic;        r : std_ulogic_vector)
    return std_ulogic_vector;
  function "or"   (l : std_ulogic_vector; r : std_ulogic       )
    return std_ulogic_vector;
  function "or"   (l : std_ulogic;        r : std_ulogic_vector)
    return std_ulogic_vector;
  function "nor"  (l : std_ulogic_vector; r : std_ulogic       )
    return std_ulogic_vector;
  function "nor"  (l : std_ulogic;        r : std_ulogic_vector)
    return std_ulogic_vector;
  function "xor"  (l : std_ulogic_vector; r : std_ulogic       )
    return std_ulogic_vector;
  function "xor"  (l : std_ulogic;        r : std_ulogic_vector)
    return std_ulogic_vector;
  function "xnor" (l : std_ulogic_vector; r : std_ulogic       )
    return std_ulogic_vector;
  function "xnor" (l : std_ulogic;        r : std_ulogic_vector)
    return std_ulogic_vector;

  function "and"  (l : std_ulogic_vector) return std_ulogic;
  function "nand" (l : std_ulogic_vector) return std_ulogic;
  function "or"   (l : std_ulogic_vector) return std_ulogic;
  function "nor"  (l : std_ulogic_vector) return std_ulogic;
  function "xor"  (l : std_ulogic_vector) return std_ulogic;
  function "xnor" (l : std_ulogic_vector) return std_ulogic;

  function "sll"  (l : std_ulogic_vector; r : integer)
    return std_ulogic_vector;
  function "srl"  (l : std_ulogic_vector; r : integer)
    return std_ulogic_vector;
  function "rol"  (l : std_ulogic_vector; r : integer)
    return std_ulogic_vector;
  function "ror"  (l : std_ulogic_vector; r : integer)
    return std_ulogic_vector;

  --  Conversion functions.
  --  The result range (for vectors) is S'Length - 1 downto 0.
  --  XMAP is return for values not in '0', '1', 'L', 'H'.
  function to_bit (s : std_ulogic; xmap : bit := '0') return bit;
  function to_bitvector (s : std_ulogic_vector; xmap : bit := '0')
    return bit_vector;

  function to_stdulogic (b : bit) return std_ulogic;
  function to_stdlogicvector (b : bit_vector) return std_logic_vector;
  function to_stdlogicvector (s : std_ulogic_vector) return std_logic_vector;
  function to_stdulogicvector (b : bit_vector) return std_ulogic_vector;
  function to_stdulogicvector (s : std_logic_vector) return std_ulogic_vector;

  alias to_bit_vector is
    to_bitvector[std_ulogic_vector, bit return bit_vector];
  alias to_bv is
    to_bitvector[std_ulogic_vector, bit return bit_vector];

  alias to_std_logic_vector is
    to_stdlogicvector[bit_vector return std_logic_vector];
  alias to_slv is
    to_stdlogicvector[bit_vector return std_logic_vector];

  alias to_std_logic_vector is
    to_stdlogicvector[std_ulogic_vector return std_logic_vector];
  alias to_slv is
    to_stdlogicvector[std_ulogic_vector return std_logic_vector];

  alias to_std_ulogic_vector is
    to_stdulogicvector[bit_vector return std_ulogic_vector];
  alias to_sulv is
    to_stdulogicvector[bit_vector return std_ulogic_vector];

  alias to_std_ulogic_vector is
    to_stdulogicvector[std_logic_vector return std_ulogic_vector];
  alias to_sulv is
    to_stdulogicvector[std_logic_vector return std_ulogic_vector];

  --  Normalization.
  --  The result range (for vectors) is 1 to S'Length.
  function to_01  (s : std_ulogic_vector; xmap : std_ulogic := '0')
    return std_ulogic_vector;
  function to_01  (s : std_ulogic;        xmap : std_ulogic := '0')
    return std_ulogic;
  function to_01  (s : bit_vector;        xmap : std_ulogic := '0')
    return std_ulogic_vector;
  function to_01  (s : bit;               xmap : std_ulogic := '0')
    return std_ulogic;

  function to_X01 (s : std_ulogic_vector) return std_ulogic_vector;
  function to_X01 (s : std_ulogic) return X01;
  function to_X01 (b : bit_vector) return std_ulogic_vector;
  function to_X01 (b : bit) return X01;

  function to_X01Z (s : std_ulogic_vector) return std_ulogic_vector;
  function to_X01Z (s : std_ulogic) return X01Z;
  function to_X01Z (b : bit_vector) return std_ulogic_vector;
  function to_X01Z (b : bit) return X01Z;

  function to_UX01 (s : std_ulogic_vector) return std_ulogic_vector;
  function to_UX01 (s : std_ulogic) return UX01;
  function to_UX01 (b : bit_vector) return std_ulogic_vector;
  function to_UX01 (b : bit) return UX01;

  function "??" (l : std_ulogic) return boolean;

  --  Edge detection.
  --  An edge is detected in case of event on s, and X01 normalized value
  --  rises from 0 to 1 or falls from 1 to 0.
  function rising_edge (signal s : std_ulogic) return boolean;
  function falling_edge (signal s : std_ulogic) return boolean;

  --  Test for unknown.  Only 0, 1, L and H are known values.
  function is_X (s : std_ulogic_vector) return boolean;
  function is_X (s : std_ulogic) return boolean;

  --  String conversion

  alias to_bstring is to_string [std_ulogic_vector return string];
  alias to_binary_string is to_string [std_ulogic_vector return string];

  function to_ostring (value : std_ulogic_vector) return string;
  alias to_octal_string is to_ostring [std_ulogic_vector return string];

  function to_hstring (value : std_ulogic_vector) return string;
  alias to_hex_string is to_hstring [std_ulogic_vector return string];

  --  Input/output

  procedure write (l : inout line; value : std_ulogic;
                   justified : side := right; field : width := 0);

  procedure write (l : inout line; value : std_ulogic_vector;
                   justified : side := right; field : width := 0);
  alias bwrite is write [line, std_ulogic_vector, side, width];
  alias binary_write is write [line, std_ulogic_vector, side, width];

  procedure owrite (l : inout line; value : std_ulogic_vector;
                    justified : side := right; field : width := 0);
  alias octal_write is owrite [line, std_ulogic_vector, side, width];

  procedure hwrite (l : inout line; value : std_ulogic_vector;
                    justified : side := right; field : width := 0);
  alias hex_write is hwrite [line, std_ulogic_vector, side, width];

  procedure read (l : inout line;
                  value : out std_ulogic; good : out boolean);
  procedure read (l : inout line; value : out std_ulogic);

  procedure read (l : inout line;
                  value : out std_ulogic_vector; good : out boolean);
  procedure read (l : inout line; value : out std_ulogic_vector);
  alias bread is read [line, std_ulogic_vector, boolean];
  alias bread is read [line, std_ulogic_vector];
  alias binary_read is read [line, std_ulogic_vector, boolean];
  alias binary_read is read [line, std_ulogic_vector];

  procedure hread (l : inout line;
                   value : out std_ulogic_vector; good : out boolean);
  procedure hread (l : inout line; value : out std_ulogic_vector);
  alias hex_read is read [line, std_ulogic_vector, boolean];
  alias hex_read is read [line, std_ulogic_vector];

  procedure oread (l : inout line;
                   value : out std_ulogic_vector; good : out boolean);
  procedure oread (l : inout line; value : out std_ulogic_vector);
  alias octal_read is read [line, std_ulogic_vector, boolean];
  alias octal_read is read [line, std_ulogic_vector];
end std_logic_1164;