drivers/net/ark/ark_pktdir.h

   1 /*-
   2  * BSD LICENSE
   3  *
   4  * Copyright (c) 2015-2017 Atomic Rules LLC
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * * Redistributions of source code must retain the above copyright
  12  * notice, this list of conditions and the following disclaimer.
  13  * * Redistributions in binary form must reproduce the above copyright
  14  * notice, this list of conditions and the following disclaimer in
  15  * the documentation and/or other materials provided with the
  16  * distribution.
  17  * * Neither the name of copyright holder nor the names of its
  18  * contributors may be used to endorse or promote products derived
  19  * from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _ARK_PKTDIR_H_
  35 #define _ARK_PKTDIR_H_
  36
  37 #include <stdint.h>
  38
  39 #define ARK_PKTDIR_BASE_ADR  0xa0000
  40
  41 typedef void *ark_pkt_dir_t;
  42
  43
  44 /* The packet director is an internal Arkville hardware module for
  45  * directing packet data in non-typical flows, such as testing.
  46  * This module is *not* intended for end-user manipulation, hence
  47  * there is minimal documentation.
  48  */
  49
  50 /*
  51  * This is an overlay structures to a memory mapped FPGA device.  These
  52  * structs will never be instantiated in ram memory
  53  */
  54 struct ark_pkt_dir_regs {
  55         uint32_t ctrl;
  56         uint32_t status;
  57         uint32_t stall_cnt;
  58 } __attribute__ ((packed));
  59
  60 struct ark_pkt_dir_inst {
  61         volatile struct ark_pkt_dir_regs *regs;
  62 };
  63
  64 ark_pkt_dir_t ark_pktdir_init(void *base);
  65 void ark_pktdir_uninit(ark_pkt_dir_t handle);
  66 void ark_pktdir_setup(ark_pkt_dir_t handle, uint32_t v);
  67 uint32_t ark_pktdir_stall_cnt(ark_pkt_dir_t handle);
  68 uint32_t ark_pktdir_status(ark_pkt_dir_t handle);
  69
  70 #endif