1/* Common hardware header file.
2   Copyright (C) 1998, 2007 Free Software Foundation, Inc.
3   Contributed by Andrew Cagney and Cygnus Support.
4
5This file is part of GDB, the GNU debugger.
6
7This program is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 3 of the License, or
10(at your option) any later version.
11
12This program is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20
21#ifndef HW_MAIN
22#define HW_MAIN
23
24/* establish a type system */
25#include "sim-basics.h"
26
27/* construct a hw device */
28#include "hw-device.h"
29#include "hw-properties.h"
30#include "hw-events.h"
31#include "hw-alloc.h"
32#include "hw-instances.h"
33#include "hw-handles.h"
34#include "hw-ports.h"
35
36/* Description of a hardware device */
37
38typedef void (hw_finish_method)
39     (struct hw *me);
40
41struct hw_descriptor {
42  const char *family;
43  hw_finish_method *to_finish;
44};
45
46/* Helper functions to make the implementation of a device easier */
47
48/* Go through the devices reg properties and look for those specifying
49   an address to attach various registers to */
50
51void do_hw_attach_regs (struct hw *me);
52
53/* Perform a polling read on FD returning either the number of bytes
54   or a hw_io status code that indicates the reason for the read
55   failure */
56
57enum {
58  HW_IO_EOF = -1, HW_IO_NOT_READY = -2, /* See: IEEE 1275 */
59};
60
61typedef int (do_hw_poll_read_method)
62     (SIM_DESC sd, int, char *, int);
63
64int do_hw_poll_read
65(struct hw *me,
66 do_hw_poll_read_method *read,
67 int sim_io_fd,
68 void *buf,
69 unsigned size_of_buf);
70
71
72#endif
73