aboutsummaryrefslogtreecommitdiff
path: root/sim/common/hw-base.h
blob: 27702c8c88752993dabd299b55564a5c75854fb7 (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
/*  This file is part of the program psim.

    Copyright (C) 1994-1998, Andrew Cagney <cagney@highland.com.au>

    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, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    */


#ifndef HW_ROOT
#define HW_ROOT

/* A root device from which dv-* devices can be built */

#include "hw-device.h"

#include "hw-properties.h"
/* #include "hw-instances.h" */
/* #include "hw-handles.h" */
#include "hw-ports.h"

typedef void (hw_finish_callback)
     (struct hw *me);

struct hw_device_descriptor {
  const char *family;
  hw_finish_callback *to_finish;
};

/* Create a primative device */

struct hw *hw_create
(struct sim_state *sd,
 struct hw *parent,
 const char *family,
 const char *name,
 const char *unit,
 const char *args);


/* Complete the creation of that device (finish overrides methods
   using the set_hw_* operations below) */

void hw_finish
(struct hw *me);

int hw_finished_p
(struct hw *me);


/* Delete the entire device */

void hw_delete
(struct hw *me);


/* Override device methods */

#define set_hw_data(hw, value) \
((hw)->data_of_hw = (value))

#define set_hw_reset(hw, method) \
((hw)->to_reset = method)

#define set_hw_io_read_buffer(hw, method) \
((hw)->to_io_read_buffer = (method))
#define set_hw_io_write_buffer(hw, method) \
((hw)->to_io_write_buffer = (method))

#define set_hw_dma_read_buffer(me, method) \
((me)->to_dma_read_buffer = (method))
#define set_hw_dma_write_buffer(me, method) \
((me)->to_dma_write_buffer = (method))

#define set_hw_attach_address(hw, method) \
((hw)->to_attach_address = (method))
#define set_hw_detach_address(hw, method) \
((hw)->to_detach_address = (method))

#define set_hw_unit_decode(hw, method) \
((hw)->to_unit_decode = (method))
#define set_hw_unit_encode(hw, method) \
((hw)->to_unit_encode = (method))

#define set_hw_unit_address_to_attach_address(hw, method) \
((hw)->to_unit_address_to_attach_address = (method))
#define set_hw_unit_size_to_attach_size(hw, method) \
((hw)->to_unit_size_to_attach_size = (method))

typedef void (hw_delete_callback)
     (struct hw *me);

#define set_hw_delete(hw, method) \
((hw)->base_of_hw->to_delete = (method))


/* Helper functions to make the implementation of a device easier */

/* Go through the devices reg properties and look for those specifying
   an address to attach various registers to */

void do_hw_attach_regs (struct hw *me);

/* Perform a polling read on FD returning either the number of bytes
   or a hw_io status code that indicates the reason for the read
   failure */

enum {
  HW_IO_EOF = -1, HW_IO_NOT_READY = -2, /* See: IEEE 1275 */
};

typedef int (do_hw_poll_read_method)
     (SIM_DESC sd, int, char *, int);

int do_hw_poll_read
(struct hw *me,
 do_hw_poll_read_method *read,
 int sim_io_fd,
 void *buf,
 unsigned size_of_buf);


/* PORTS */

extern void create_hw_port_data
(struct hw *hw);
extern void delete_hw_port_data
(struct hw *hw);


#endif