cvmx-packet.h revision 210286
1/***********************license start*************** 2 * Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights 3 * reserved. 4 * 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are 8 * met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 13 * * Redistributions in binary form must reproduce the above 14 * copyright notice, this list of conditions and the following 15 * disclaimer in the documentation and/or other materials provided 16 * with the distribution. 17 * 18 * * Neither the name of Cavium Networks nor the names of 19 * its contributors may be used to endorse or promote products 20 * derived from this software without specific prior written 21 * permission. 22 * 23 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 24 * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS 25 * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH 26 * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY 27 * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT 28 * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES 29 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR 30 * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET 31 * POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT 32 * OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 33 * 34 * 35 * For any questions regarding licensing please contact marketing@caviumnetworks.com 36 * 37 ***********************license end**************************************/ 38 39 40 41 42 43 44/** 45 * @file 46 * 47 * Packet buffer defines. 48 * 49 * <hr>$Revision: 41586 $<hr> 50 * 51 * 52 */ 53 54#ifndef __CVMX_PACKET_H__ 55#define __CVMX_PACKET_H__ 56 57#ifdef __cplusplus 58extern "C" { 59#endif 60 61/** 62 * This structure defines a buffer pointer on Octeon 63 */ 64typedef union 65{ 66 void* ptr; 67 uint64_t u64; 68 struct 69 { 70 uint64_t i : 1; /**< if set, invert the "free" pick of the overall packet. HW always sets this bit to 0 on inbound packet */ 71 uint64_t back : 4; /**< Indicates the amount to back up to get to the buffer start in cache lines. In most cases 72 this is less than one complete cache line, so the value is zero */ 73 uint64_t pool : 3; /**< The pool that the buffer came from / goes to */ 74 uint64_t size :16; /**< The size of the segment pointed to by addr (in bytes) */ 75 uint64_t addr :40; /**< Pointer to the first byte of the data, NOT buffer */ 76 } s; 77} cvmx_buf_ptr_t; 78 79#ifdef __cplusplus 80} 81#endif 82 83#endif /* __CVMX_PACKET_H__ */ 84 85