numam-dpdk/drivers/net/ark/ark_ddm.h
Ed Czeck cf18d4def2 net/ark: provide API for hardware modules UDM and DDM
Provide C-level interface for Arkville's internal HW resources
DDM (Downstream Data Mover) and UDM (Upstream Data Mover) modules

Signed-off-by: Ed Czeck <ed.czeck@atomicrules.com>
2017-04-19 15:37:37 +02:00

178 lines
5.6 KiB
C

/*-
* BSD LICENSE
*
* Copyright (c) 2015-2017 Atomic Rules LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of copyright holder nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _ARK_DDM_H_
#define _ARK_DDM_H_
#include <stdint.h>
#include <rte_memory.h>
/* The DDM or Downstream Data Mover is an internal Arkville hardware
* module for moving packet from host memory to the TX packet streams.
* This module is *not* intended for end-user manipulation, hence
* there is minimal documentation.
*/
/* struct defining Tx meta data -- fixed in FPGA -- 16 bytes */
struct ark_tx_meta {
uint64_t physaddr;
uint32_t delta_ns;
uint16_t data_len; /* of this MBUF */
#define ARK_DDM_EOP 0x01
#define ARK_DDM_SOP 0x02
uint8_t flags; /* bit 0 indicates last mbuf in chain. */
uint8_t reserved[1];
};
/*
* DDM core hardware structures
* These are overlay structures to a memory mapped FPGA device. These
* structs will never be instantiated in ram memory
*/
#define ARK_DDM_CFG 0x0000
#define ARK_DDM_CONST 0xfacecafe
struct ark_ddm_cfg_t {
uint32_t r0;
volatile uint32_t tlp_stats_clear;
uint32_t const0;
volatile uint32_t tag_max;
volatile uint32_t command;
volatile uint32_t stop_flushed;
};
#define ARK_DDM_STATS 0x0020
struct ark_ddm_stats_t {
volatile uint64_t tx_byte_count;
volatile uint64_t tx_pkt_count;
volatile uint64_t tx_mbuf_count;
};
#define ARK_DDM_MRDQ 0x0040
struct ark_ddm_mrdq_t {
volatile uint32_t mrd_q1;
volatile uint32_t mrd_q2;
volatile uint32_t mrd_q3;
volatile uint32_t mrd_q4;
volatile uint32_t mrd_full;
};
#define ARK_DDM_CPLDQ 0x0068
struct ark_ddm_cpldq_t {
volatile uint32_t cpld_q1;
volatile uint32_t cpld_q2;
volatile uint32_t cpld_q3;
volatile uint32_t cpld_q4;
volatile uint32_t cpld_full;
};
#define ARK_DDM_MRD_PS 0x0090
struct ark_ddm_mrd_ps_t {
volatile uint32_t mrd_ps_min;
volatile uint32_t mrd_ps_max;
volatile uint32_t mrd_full_ps_min;
volatile uint32_t mrd_full_ps_max;
volatile uint32_t mrd_dw_ps_min;
volatile uint32_t mrd_dw_ps_max;
};
#define ARK_DDM_QUEUE_STATS 0x00a8
struct ark_ddm_qstats_t {
volatile uint64_t byte_count;
volatile uint64_t pkt_count;
volatile uint64_t mbuf_count;
};
#define ARK_DDM_CPLD_PS 0x00c0
struct ark_ddm_cpld_ps_t {
volatile uint32_t cpld_ps_min;
volatile uint32_t cpld_ps_max;
volatile uint32_t cpld_full_ps_min;
volatile uint32_t cpld_full_ps_max;
volatile uint32_t cpld_dw_ps_min;
volatile uint32_t cpld_dw_ps_max;
};
#define ARK_DDM_SETUP 0x00e0
struct ark_ddm_setup_t {
phys_addr_t cons_write_index_addr;
uint32_t write_index_interval; /* 4ns each */
volatile uint32_t cons_index;
};
#define ARK_DDM_EXPECTED_SIZE 256
#define ARK_DDM_QOFFSET ARK_DDM_EXPECTED_SIZE
/* Consolidated structure */
struct ark_ddm_t {
struct ark_ddm_cfg_t cfg;
uint8_t reserved0[(ARK_DDM_STATS - ARK_DDM_CFG) -
sizeof(struct ark_ddm_cfg_t)];
struct ark_ddm_stats_t stats;
uint8_t reserved1[(ARK_DDM_MRDQ - ARK_DDM_STATS) -
sizeof(struct ark_ddm_stats_t)];
struct ark_ddm_mrdq_t mrdq;
uint8_t reserved2[(ARK_DDM_CPLDQ - ARK_DDM_MRDQ) -
sizeof(struct ark_ddm_mrdq_t)];
struct ark_ddm_cpldq_t cpldq;
uint8_t reserved3[(ARK_DDM_MRD_PS - ARK_DDM_CPLDQ) -
sizeof(struct ark_ddm_cpldq_t)];
struct ark_ddm_mrd_ps_t mrd_ps;
struct ark_ddm_qstats_t queue_stats;
struct ark_ddm_cpld_ps_t cpld_ps;
uint8_t reserved5[(ARK_DDM_SETUP - ARK_DDM_CPLD_PS) -
sizeof(struct ark_ddm_cpld_ps_t)];
struct ark_ddm_setup_t setup;
uint8_t reserved_p[(ARK_DDM_EXPECTED_SIZE - ARK_DDM_SETUP) -
sizeof(struct ark_ddm_setup_t)];
};
/* DDM function prototype */
int ark_ddm_verify(struct ark_ddm_t *ddm);
void ark_ddm_start(struct ark_ddm_t *ddm);
int ark_ddm_stop(struct ark_ddm_t *ddm, const int wait);
void ark_ddm_reset(struct ark_ddm_t *ddm);
void ark_ddm_stats_reset(struct ark_ddm_t *ddm);
void ark_ddm_setup(struct ark_ddm_t *ddm, phys_addr_t cons_addr,
uint32_t interval);
void ark_ddm_dump_stats(struct ark_ddm_t *ddm, const char *msg);
void ark_ddm_dump(struct ark_ddm_t *ddm, const char *msg);
int ark_ddm_is_stopped(struct ark_ddm_t *ddm);
uint64_t ark_ddm_queue_byte_count(struct ark_ddm_t *ddm);
uint64_t ark_ddm_queue_pkt_count(struct ark_ddm_t *ddm);
void ark_ddm_queue_reset_stats(struct ark_ddm_t *ddm);
#endif