osm_vendor_mlx_sar.h revision 219820
1/* 2 * Copyright (c) 2004, 2005 Voltaire, Inc. All rights reserved. 3 * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved. 4 * Copyright (c) 1996-2003 Intel Corporation. All rights reserved. 5 * 6 * This software is available to you under a choice of one of two 7 * licenses. You may choose to be licensed under the terms of the GNU 8 * General Public License (GPL) Version 2, available from the file 9 * COPYING in the main directory of this source tree, or the 10 * OpenIB.org BSD license below: 11 * 12 * Redistribution and use in source and binary forms, with or 13 * without modification, are permitted provided that the following 14 * conditions are met: 15 * 16 * - Redistributions of source code must retain the above 17 * copyright notice, this list of conditions and the following 18 * disclaimer. 19 * 20 * - Redistributions in binary form must reproduce the above 21 * copyright notice, this list of conditions and the following 22 * disclaimer in the documentation and/or other materials 23 * provided with the distribution. 24 * 25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 32 * SOFTWARE. 33 * 34 */ 35 36#ifndef _OSMV_SAR_H_ 37#define _OSMV_SAR_H_ 38 39#include <iba/ib_types.h> 40#include <complib/cl_qlist.h> 41 42#ifdef __cplusplus 43# define BEGIN_C_DECLS extern "C" { 44# define END_C_DECLS } 45#else /* !__cplusplus */ 46# define BEGIN_C_DECLS 47# define END_C_DECLS 48#endif /* __cplusplus */ 49 50BEGIN_C_DECLS 51 52typedef struct _osmv_rmpp_sar { 53 void *p_arbt_mad; 54 uint32_t data_len; /* total data len in all the mads */ 55 /* these data members contain only constants */ 56 uint32_t hdr_sz; 57 uint32_t data_sz; /*typical data sz for this kind of mad (sa or regular */ 58 59} osmv_rmpp_sar_t; 60 61/* 62 * NAME 63 * osmv_rmpp_sar_alloc 64 * 65 * DESCRIPTION 66 * c'tor for rmpp_sar object 67 * 68 * SEE ALSO 69 * 70 */ 71ib_api_status_t 72osmv_rmpp_sar_init(osmv_rmpp_sar_t * p_sar, void *p_arbt_mad, 73 uint32_t mad_size, boolean_t is_sa_mad); 74 75/* 76 * NAME 77 * osmv_rmpp_sar_dealloc 78 * 79 * DESCRIPTION 80 * d'tor for rmpp_sar object 81 * 82 * SEE ALSO 83 * 84 */ 85void osmv_rmpp_sar_done(osmv_rmpp_sar_t * p_sar); 86 87/* 88 * NAME 89 * osmv_rmpp_sar_get_mad_seg 90 * 91 * DESCRIPTION 92 * segments the original mad buffer . returnes a mad with the data of the i-th segment 93 * 94 * SEE ALSO 95 * 96 */ 97ib_api_status_t 98osmv_rmpp_sar_get_mad_seg(osmv_rmpp_sar_t * p_sar, uint32_t seg_idx, 99 void *p_buf); 100 101/* 102 * NAME 103 * osmv_rmpp_sar_reassemble_arbt_mad 104 * 105 * DESCRIPTION 106 * gets a qlist of mads and reassmbles to one big mad buffer 107 * ALSO - deallocates the mad list 108 * 109 * SEE ALSO 110 * 111 */ 112ib_api_status_t 113osmv_rmpp_sar_reassemble_arbt_mad(osmv_rmpp_sar_t * p_sar, cl_qlist_t * p_bufs); 114 115END_C_DECLS 116#endif /* _OSMV_SAR_H_ */ 117