linux/drivers/net/ethernet/freescale/fman/fman_sp.h
<<
>>
Prefs
   1/*
   2 * Copyright 2008 - 2015 Freescale Semiconductor Inc.
   3 *
   4 * Redistribution and use in source and binary forms, with or without
   5 * modification, are permitted provided that the following conditions are met:
   6 *     * Redistributions of source code must retain the above copyright
   7 *       notice, this list of conditions and the following disclaimer.
   8 *     * Redistributions in binary form must reproduce the above copyright
   9 *       notice, this list of conditions and the following disclaimer in the
  10 *       documentation and/or other materials provided with the distribution.
  11 *     * Neither the name of Freescale Semiconductor nor the
  12 *       names of its contributors may be used to endorse or promote products
  13 *       derived from this software without specific prior written permission.
  14 *
  15 * ALTERNATIVELY, this software may be distributed under the terms of the
  16 * GNU General Public License ("GPL") as published by the Free Software
  17 * Foundation, either version 2 of that License or (at your option) any
  18 * later version.
  19 *
  20 * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
  21 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23 * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
  24 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31
  32#ifndef __FM_SP_H
  33#define __FM_SP_H
  34
  35#include "fman.h"
  36#include <linux/types.h>
  37
  38#define ILLEGAL_BASE    (~0)
  39
  40/* defaults */
  41#define DFLT_FM_SP_BUFFER_PREFIX_CONTEXT_DATA_ALIGN     64
  42
  43/* Registers bit fields */
  44#define FMAN_SP_EXT_BUF_POOL_EN_COUNTER         0x40000000
  45#define FMAN_SP_EXT_BUF_POOL_VALID                      0x80000000
  46#define FMAN_SP_EXT_BUF_POOL_BACKUP                     0x20000000
  47#define FMAN_SP_DMA_ATTR_WRITE_OPTIMIZE         0x00100000
  48#define FMAN_SP_SG_DISABLE                              0x80000000
  49
  50/* shifts */
  51#define FMAN_SP_EXT_BUF_MARG_START_SHIFT                16
  52#define FMAN_SP_DMA_ATTR_SWP_SHIFT                      30
  53#define FMAN_SP_IC_TO_EXT_SHIFT                 16
  54#define FMAN_SP_IC_FROM_INT_SHIFT                       8
  55
  56/* structure for defining internal context copying */
  57struct fman_sp_int_context_data_copy {
  58        /* < Offset in External buffer to which internal
  59         *  context is copied to (Rx) or taken from (Tx, Op).
  60         */
  61        u16 ext_buf_offset;
  62        /* Offset within internal context to copy from
  63         * (Rx) or to copy to (Tx, Op).
  64         */
  65        u8 int_context_offset;
  66        /* Internal offset size to be copied */
  67        u16 size;
  68};
  69
  70/*  struct for defining external buffer margins */
  71struct fman_sp_buf_margins {
  72        /* Number of bytes to be left at the beginning
  73         * of the external buffer (must be divisible by 16)
  74         */
  75        u16 start_margins;
  76        /* number of bytes to be left at the end
  77         * of the external buffer(must be divisible by 16)
  78         */
  79        u16 end_margins;
  80};
  81
  82struct fman_sp_buffer_offsets {
  83        u32 data_offset;
  84        u32 prs_result_offset;
  85        u32 time_stamp_offset;
  86        u32 hash_result_offset;
  87};
  88
  89int fman_sp_build_buffer_struct(struct fman_sp_int_context_data_copy
  90                                *int_context_data_copy,
  91                                struct fman_buffer_prefix_content
  92                                *buffer_prefix_content,
  93                                struct fman_sp_buf_margins *buf_margins,
  94                                struct fman_sp_buffer_offsets
  95                                *buffer_offsets,
  96                                u8 *internal_buf_offset);
  97
  98void fman_sp_set_buf_pools_in_asc_order_of_buf_sizes(struct fman_ext_pools
  99                                                     *fm_ext_pools,
 100                                                     u8 *ordered_array,
 101                                                     u16 *sizes_array);
 102
 103#endif  /* __FM_SP_H */
 104