1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _VNET_COMMON_H 28 #define _VNET_COMMON_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 #include <sys/vio_common.h> 35 #include <sys/vio_mailbox.h> 36 #include <sys/ethernet.h> 37 38 /* 39 * This header file contains definitions common to LDoms Virtual Network 40 * server (vsw) and client (vnet). 41 */ 42 43 /* max # of cookies per frame size in TxDring mode */ 44 #define MAX_COOKIES ((ETHERMAX >> MMU_PAGESHIFT) + 2ULL) 45 46 /* 47 * Max # of data area cookies that we support in RxDringData mode. This is 48 * pre-defined to avoid allocating and importing a large # of cookies for the 49 * data area. We know that the export map table on the exporting end point is 50 * per LDC. We also know that a single cookie can be obtained if we manage 51 * to get consecutive entries in the export map table. We use this knowledge to 52 * limit the # of cookies to a pre-defined maximum value. 53 */ 54 #define VNET_DATA_AREA_COOKIES 32 55 56 /* 57 * Size of dring reg msg in RxDringData mode, given # of data area cookies. 58 * This assumes that the # of dring cookies in vio_dring_reg_msg_t is 1. 59 * The given # of data area cookies is reduced by 1, as vio_dring_reg_msg_ext_t 60 * itself contains 1 data cookie. 61 */ 62 #define VNET_DRING_REG_EXT_MSG_SIZE(data_ncookies) \ 63 (sizeof (vio_dring_reg_msg_t) + sizeof (vio_dring_reg_ext_msg_t) + \ 64 (((data_ncookies) - 1) * sizeof (ldc_mem_cookie_t))) 65 66 /* Max supported size of dring reg msg in RxDringData mode */ 67 #define VNET_DRING_REG_EXT_MSG_SIZE_MAX \ 68 VNET_DRING_REG_EXT_MSG_SIZE(VNET_DATA_AREA_COOKIES) 69 70 /* initial send sequence number */ 71 #define VNET_ISS 0x1 72 73 #define VNET_START_IDX_UNSPEC 0xFFFFFFFF /* ignore st_idx in dringdata ack */ 74 75 #define VNET_2K (1 << 11) 76 #define VNET_4K (1 << 12) 77 #define VNET_8K (1 << 13) 78 #define VNET_12K ((VNET_8K) + (VNET_4K)) 79 #define VNET_IPALIGN 6 /* padding for IP header alignment */ 80 #define VNET_LDCALIGN 8 /* padding for ldc_mem_copy() align */ 81 #define VNET_ROUNDUP_2K(n) (((n) + (VNET_2K - 1)) & ~(VNET_2K - 1)) 82 #define VNET_ROUNDUP_4K(n) (((n) + (VNET_4K - 1)) & ~(VNET_4K - 1)) 83 #define VNET_ROUNDUP_8K(n) (((n) + (VNET_8K - 1)) & ~(VNET_8K - 1)) 84 85 #define MEMBAR_CONSUMER membar_consumer 86 #define MEMBAR_PRODUCER membar_producer 87 88 /* 89 * Maximum MTU value currently supported. MAX_COOKIES for data has been defined 90 * already based on ETHERMAX. Hence we limit the MTU to be within 2 8K pages 91 * and take some additional steps (see related code in .c files) to ensure that 92 * ldc cookies for each data buffer is within the MAX_COOKIES. This allows us 93 * to support Jumbo MTUs without changing the size of the descriptor. 94 */ 95 #define VNET_MAX_MTU 16000 96 97 #define VNET_NUM_HANDSHAKES 6 /* # of handshake attempts */ 98 99 /* vnet descriptor */ 100 typedef struct vnet_public_desc { 101 vio_dring_entry_hdr_t hdr; /* descriptor header */ 102 uint32_t nbytes; /* data length */ 103 uint32_t ncookies; /* number of data cookies */ 104 ldc_mem_cookie_t memcookie[MAX_COOKIES]; /* data cookies */ 105 } vnet_public_desc_t; 106 107 /* 108 * Vnet in-band descriptor. Used by those vnet clients 109 * such as OBP who do not use descriptor rings. 110 */ 111 typedef struct vnet_ibnd_desc { 112 vio_inband_desc_msg_hdr_t hdr; 113 114 /* payload */ 115 uint32_t nbytes; 116 uint32_t ncookies; 117 ldc_mem_cookie_t memcookie[MAX_COOKIES]; 118 } vnet_ibnd_desc_t; 119 120 /* 121 * Descriptor format in RxDringData mode. 122 */ 123 typedef struct vnet_rxdring_data_desc { 124 uint8_t dstate; /* Descriptor state */ 125 uint8_t resv1[3]; /* Reserved */ 126 uint32_t nbytes; /* Num bytes in data buffer */ 127 uint64_t data_buf_offset; /* Offset of data buffer */ 128 } vnet_rx_dringdata_desc_t; 129 130 /* exported functions */ 131 uint64_t vnet_macaddr_strtoul(const uint8_t *macaddr); 132 void vnet_macaddr_ultostr(uint64_t value, uint8_t *macaddr); 133 mblk_t *vnet_vlan_insert_tag(mblk_t *mp, uint16_t vid); 134 mblk_t *vnet_vlan_remove_tag(mblk_t *mp); 135 int vnet_dring_entry_copy(vnet_public_desc_t *dst, vnet_public_desc_t *src, 136 uint8_t mtype, ldc_dring_handle_t handle, uint64_t start, uint64_t stop); 137 int vnet_dring_entry_set_dstate(vnet_public_desc_t *descp, uint8_t mtype, 138 ldc_dring_handle_t handle, uint64_t start, uint64_t stop, uint8_t dstate); 139 140 #ifdef __cplusplus 141 } 142 #endif 143 144 #endif /* _VNET_COMMON_H */ 145