include/grlib/gr_tmtc_1553.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*  GR-TMTC-1553 PCI Target driver.
0004  *
0005  *  COPYRIGHT (c) 2010.
0006  *  Cobham Gaisler AB.
0007  *
0008  *  Configures the GR-TMTC-1553 interface PCI board.
0009  *  This driver provides a AMBA PnP bus by using the general part
0010  *  of the AMBA PnP bus driver (ambapp_bus.c).
0011  *
0012  *  Driver resources for the AMBA PnP bus provided can be set using
0013  *  gr_tmtc_1553_set_resources().
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef __GR_TMTC_1553_H__
0038 #define __GR_TMTC_1553_H__
0039
0040 #include <drvmgr/drvmgr.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif
0045
0046 /* An array of pointers to GR-TMTC-1553 resources. The resources will be
0047  * used by the drivers controlling the cores on the GR-TMTC-1553 target AMBA bus.
0048  *
0049  * The gr_rasta_io_resources is declared weak so that the user can override the
0050  * default configuration. The array must be terminated with a NULL resource.
0051  */
0052 extern struct drvmgr_bus_res *gr_tmtc_1553_resources[];
0053
0054 /* Options to gr_rasta_io_print function */
0055 #define TMTC_1553_OPTIONS_AMBA   0x01 /* Print AMBA bus devices */
0056 #define TMTC_1553_OPTIONS_IRQ    0x02 /* Print current IRQ setup */
0057
0058 /* Print information about GR-RASTA-IO PCI board */
0059 void gr_tmtc_1553_print(int options);
0060
0061 /* Register GR-RASTA-IO driver */
0062 void gr_tmtc_1553_register_drv(void);
0063
0064 /* Print information about all GR-TMTC-1553 devices registered to this driver */
0065 void gr_tmtc_1553_print(int options);
0066
0067 /* Print information about one GR-TMTC-1553 device */
0068 void gr_tmtc_1553_print_dev(struct drvmgr_dev *dev, int options);
0069
0070 #ifdef __cplusplus
0071 }
0072 #endif
0073
0074 #endif