Files
@ d0a14f973771
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public/vmkernel64/release/net/vmkapi_net_poll.h
d0a14f973771
13.5 KiB
text/x-chdr
ESXi-5.0-U1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | /* **********************************************************
* Copyright 2006 - 2010 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* NetPoll */ /**
* \addtogroup Network
*@{
* \defgroup NetPoll NetPoll
*@{
*
* \par NetPoll:
*
* Create and access poll data structure for network devices. The net
* poll routine polls packet from the device and pushes those packets
* up the stack. It also performs tx completions for the device.
*
* The poll is initialized using vmk_NetPollInit and takes two
* callbacks. The first callback is used to poll packets from the
* network device. Once the packets has been polled, the net poll
* routine will either use the default push processing or call the
* second callback to do custom push processing for these packets.
* Once the poll is activated it will run while there are packets to
* be processed.
*
***********************************************************************
*/
#ifndef _VMKAPI_NET_POLL_H_
#define _VMKAPI_NET_POLL_H_
/** \cond never */
#ifndef VMK_HEADER_INCLUDED_FROM_VMKAPI_H
#error This vmkapi file should never be included directly but only via vmkapi.h
#endif
/** \endcond never */
#include "net/vmkapi_net_types.h"
#include "net/vmkapi_net_uplink.h"
#include "net/vmkapi_net_pktlist.h"
/*
* \ingroup NetPoll.
* \brief Net poll features.
*/
typedef enum {
/**
* \brief Use default push routine.
*/
VMK_NETPOLL_NONE = 0,
/**
* \brief Use custom push routine.
*/
VMK_NETPOLL_CUSTOM_DELIVERY_CALLBACK = 1,
} vmk_NetPollFeatures;
/*
* \ingroup NetPoll.
* \brief Net poll state.
*/
typedef enum {
/**
* \brief Net poll is disabled.
*/
VMK_NETPOLL_DISABLED = 0,
/**
* \brief Net poll is running or scheduled.
*/
VMK_NETPOLL_ACTIVE = 1,
} vmk_NetPollState;
/**
* \brief Net poll object.
*/
typedef struct vmk_NetPollInt *vmk_NetPoll;
/*
***********************************************************************
* vmk_NetPollCallback -- */ /**
*
* \ingroup NetPoll
* \brief Poll routine for the device
*
* \param[in] priv Private data structure for device poll routine.
*
* \retval Whether to poll the device for more packets.
*
***********************************************************************
*/
typedef vmk_Bool (*vmk_NetPollCallback) (void *priv);
/*
***********************************************************************
* vmk_NetPollDeliveryCallback -- */ /**
*
* \ingroup NetPoll
* \brief Custom push routine for processing the packets received.
*
* \param[in] rxPktList Packet list for the custom push routine.
* \param[in] priv Private data structure for device poll routine
*
***********************************************************************
*/
typedef void (*vmk_NetPollDeliveryCallback) (vmk_PktList rxPktList,
void *priv);
/*
* \ingroup NetPoll.
* \brief Net poll initialization variables.
*/
typedef struct vmk_NetPollProperties {
/**
* \brief Device poll routine.
*/
vmk_NetPollCallback poll;
/**
* \brief Custom device push routine.
*
* If this parameter is not NULL and
* NETPOLL_CUSTOM_DELIVERY_Callback is set in the
* features parameter then packets
* will NOT be pushed up to the vmkernel
* networking stack, they will be passed to this
* callback instead.
*/
vmk_NetPollDeliveryCallback deliveryCallback;
/**
* \brief Poll private data handler.
*/
void *priv;
/**
* \brief Poll features.
*/
vmk_NetPollFeatures features;
} vmk_NetPollProperties;
/*
***********************************************************************
* vmk_NetPollActivate -- */ /**
*
* \ingroup NetPoll
* \brief Activate the poll thread.
*
* The poll thread calls the device callback for polling packets.
* These packets are pushed up the stack by the default push routine
* or the custom callback used during the initialization. The poll
* thread continues to push packets while the device has pending packets.
*
* \param[in] netPoll Handler for the net poll.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid poll context.
* \retval VMK_FAILURE Poll could not be activated.
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollActivate(vmk_NetPoll netPoll);
/*
***********************************************************************
* vmk_NetPollChangeCallback -- */ /**
*
* \ingroup NetPoll
* \brief Set new features for net poll handler.
*
* Net poll routine will use the new callbacks.
*
* \param[in] netPoll Handler for the net poll.
* \param[in] init New properties for the poll handler.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid poll context.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollChangeCallback(vmk_NetPoll netPoll,
vmk_NetPollProperties *init);
/*
***********************************************************************
* vmk_NetPollCheckState -- */ /**
*
* \ingroup NetPoll
* \brief Get the poll state.
*
* The state indicates whether the poll is active or suspended.
*
* \param[in] netPoll Handler for the net poll.
* \param[out] state The state of the poll.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid poll context.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollCheckState(vmk_NetPoll netPoll,
vmk_NetPollState *state);
/*
***********************************************************************
* vmk_NetPollCleanup -- */ /**
*
* \ingroup NetPoll
* \brief Remove the poll thread.
*
* \param[in] netPoll Handler for the net poll.
*
***********************************************************************
*/
void vmk_NetPollCleanup(vmk_NetPoll netPoll);
/*
************************************************************************
* vmk_NetPollGetCurrent -- */ /**
*
* \ingroup NetPoll
* \brief Get the current executing net poll context.
*
* \param[out] netPoll Handler for the poll.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid poll context.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollGetCurrent(vmk_NetPoll *netPoll);
/*
************************************************************************
* vmk_NetPollGetPrivate -- */ /**
*
* \ingroup NetPoll
* \brief Return the private data registered for the device callback.
*
* \param[in] netPoll Handler for the net poll.
*
* \return Void address registered with the
* device callback.
*
***********************************************************************
*/
void * vmk_NetPollGetPrivate(vmk_NetPoll netPoll);
/*
***********************************************************************
* vmk_NetPollInit -- */ /**
*
* \brief Initialize a net poll routine
*
* \param[in] pollInit Poll initialization parameters.
* \param[in] id Vmkernel Service Account.
* \param[out] poll Handler for the Net Poll.
*
* \retval VMK_OK Success.
* \retval VMK_FAILURE Poll initialization failed.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollInit(vmk_NetPollProperties *pollInit,
vmk_ServiceAcctID id,
vmk_NetPoll *poll);
/*
***********************************************************************
* vmk_NetPollQueueRxPkt -- */ /**
*
* \ingroup NetPoll
* \brief Queue packets received from the NIC.
*
* \pre The poll should be in active state.
*
* \param[in] netPoll Handler for the net poll.
* \param[in] pkt Packet to be queued.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid poll handle.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollQueueRxPkt(vmk_NetPoll netPoll,
vmk_PktHandle *pkt);
/*
***********************************************************************
* vmk_NetPollQueueCompPkt -- */ /**
*
* \ingroup NetPoll
* \brief Queue packets for tx completion or queue received packets that
* need to be released on error.
*
* \pre The poll should be in active state.
*
* \param[in] netPoll Handler for the net poll.
* \param[in] pkt Packet to be queued.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid poll handle.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollQueueCompPkt(vmk_NetPoll netPoll,
vmk_PktHandle *pkt);
/*
***********************************************************************
* vmk_NetPollVectorSet -- */ /**
*
* \ingroup NetPoll
* \brief Set the associated vector with the poll.
*
* Vmkernel can have an interrupt vector be associated with the network
* poll so that the interrupt handler can be affinitized with the poll
* routine.
*
* \param[in] netPoll Handler for the net poll.
* \param[in] vector Interrupt vector.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid Poll handle.
* \retval VMK_BAD_PARAM If invalid vector specified or vector could
* not be controlled.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollVectorSet(vmk_NetPoll netPoll,
vmk_uint32 vector);
/*
***********************************************************************
* vmk_NetPollVectorUnSet -- */ /**
*
* \ingroup NetPoll
* \brief Clear the interrupt vector registered with the poll.
*
* \param[in] netPoll Handler for the net poll.
*
* \retval VMK_OK Success.
* \retval VMK_INVALID_HANDLE Invalid Poll handle.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollVectorUnSet(vmk_NetPoll netPoll);
/*
***********************************************************************
* vmk_NetPollRegisterUplink -- */ /**
*
* \ingroup NetPoll
* \brief Register the uplink for the poll.
*
* Each poll requires uplink port if they are to use the poll callback.
* However if the device provides its own custom callback, no
* registration for uplink is required.
*
* A poll can have just one uplink be registered. Adding another uplink
* will return error. However an uplink can be shared by multiple
* net polls. But the uplink can have only one default poll registered.
* The default poll is registered using the defaultPoll during the
* initialization process. Once a default poll is registered it cannot
* be overwritten.
*
* \param[in] netPoll Handler for the net poll.
* \param[in] uplink Uplink from where the packets came from.
* \param[in] name Descriptive name for the poll.
* \param[in] defaultPoll Whether the net poll is default poll for
* the NIC.
*
* \retval VMK_OK Success.
* \retval VMK_BAD_PARAM Invalid uplink assignment.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollRegisterUplink(vmk_NetPoll netPoll,
vmk_Uplink uplink,
vmk_Name name,
vmk_Bool defaultPoll);
/*
***********************************************************************
* vmk_NetPollUnregisterUplink -- */ /**
*
* \ingroup NetPoll
* \brief Unregister the uplink for the poll.
*
* \param[in] netPoll Handler for the net poll.
*
* \retval VMK_OK Success.
* \retval VMK_BAD_PARAM Invalid uplink assignment.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NetPollUnregisterUplink(vmk_NetPoll netPoll);
/*
************************************************************************
* vmk_NetPollProcessRx -- */ /**
*
* \ingroup NetPoll
* \brief Process packets stored in the net poll list.
*
* \param[in] netPoll Handler for the net poll.
*
***********************************************************************
*/
void vmk_NetPollProcessRx(vmk_NetPoll netPoll);
#endif /* _VMKAPI_NET_POLL_H_ */
/** @} */
/** @} */
|