sys/dev/altera/avgen/altera_avgen.h

   1 /*-
   2  * Copyright (c) 2012 Robert N. M. Watson
   3  * All rights reserved.
   4  *
   5  * This software was developed by SRI International and the University of
   6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
   7  * ("CTSRD"), as part of the DARPA CRASH research programme.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _DEV_ALTERA_AVALON_H_
  34 #define _DEV_ALTERA_AVALON_H_
  35
  36 struct altera_avgen_softc {
  37         /*
  38          * Bus-related fields.
  39          */
  40         device_t         avg_dev;
  41         int              avg_unit;
  42
  43         /*
  44          * The device node and memory-mapped I/O region.
  45          */
  46         struct cdev     *avg_cdev;
  47         struct resource *avg_res;
  48         int              avg_rid;
  49
  50         /*
  51          * Access properties configured by device.hints.
  52          */
  53         u_int            avg_flags;
  54         u_int            avg_width;
  55 };
  56
  57 /*
  58  * Various flags extracted from device.hints to configure operations on the
  59  * device.
  60  */
  61 #define ALTERA_AVALON_FLAG_READ                 0x01
  62 #define ALTERA_AVALON_FLAG_WRITE                0x02
  63 #define ALTERA_AVALON_FLAG_MMAP_READ            0x04
  64 #define ALTERA_AVALON_FLAG_MMAP_WRITE           0x08
  65 #define ALTERA_AVALON_FLAG_MMAP_EXEC            0x10
  66
  67 #define ALTERA_AVALON_CHAR_READ                 'r'
  68 #define ALTERA_AVALON_CHAR_WRITE                'w'
  69 #define ALTERA_AVALON_CHAR_EXEC                 'x'
  70
  71 #define ALTERA_AVALON_STR_WIDTH                 "width"
  72 #define ALTERA_AVALON_STR_FILEIO                "fileio"
  73 #define ALTERA_AVALON_STR_MMAPIO                "mmapio"
  74 #define ALTERA_AVALON_STR_DEVNAME               "devname"
  75 #define ALTERA_AVALON_STR_DEVUNIT               "devunit"
  76
  77 /*
  78  * Driver setup routines from the bus attachment/teardown.
  79  */
  80 int     altera_avgen_attach(struct altera_avgen_softc *sc,
  81             const char *str_fileio, const char *str_mmapio,
  82             const char *str_devname, int devunit);
  83 void    altera_avgen_detach(struct altera_avgen_softc *sc);
  84
  85 extern devclass_t       altera_avgen_devclass;
  86
  87 #endif /* _DEV_ALTERA_AVALON_H_ */