Main Page Modules Alphabetical List Data Structures File List Data Fields Globals

IxCryptoAccCodelet_p.h File Reference

This is private header file for the Crypto Access Component Codelet. More...

Go to the source code of this file.

Data Structures

struct IxCryptoCodeletServiceParam

Structure holding various configuration parameters for demonstration purposes. More...

Defines

#define IX_CRYPTOACC_CODELET_MAX_STR_SIZE

Maximum size of info string.

#define IX_CRYPTO_ACC_CODELET_DRV_DMA_FREE(pData, size)

To free the memory allocated through IX_CRYPTO_ACC_DRV_DMA_MALLOC function.

Functions

PRIVATE IX_STATUS ixCryptoAccCodeletInit (IxCryptoAccCfg ixCryptoAccCodeletCfg)

This function initialises the neccessary components.

INLINE BOOL ixCryptoAccCodeletBufIsQEmpty (void)

This inline function is used to check whether the buffer queue is empty.

INLINE BOOL ixCryptoAccCodeletBufIsQFull (void)

This inline function is used to check whether the buffer queue is full.

void ixCryptoAccCodeletCryptoMbufToQTailAdd (IX_MBUF *pMbufToAdd)

This function adds a mbuf to the tail of the queue.

void ixCryptoAccCodeletCryptoMbufFromQHeadRemove (IX_MBUF **pMbufToRem)

This function removes a mbuf from the head of the queue.

IX_STATUS ixCryptoAccCodeletCryptoMemPoolInit (UINT32 pktLen)

This function initialises mbuf pool for the Crypto Access Codelet.

void ixCryptoAccCodeletCryptoMemPoolFree (UINT32 pktLen)

Free all resources in Crypto Access Codelet MBUF pool.

IX_STATUS ixCryptoAccCodeletNpeInit (IxNpeDlNpeId npeId, IxNpeDlBuildId buildId)

This function is to download the latest crypto NPE image into NPE.

void ixCryptoAccCodeletDispatcherPoll (void)

This function polls the queues when poll mode set in the function ixCryptoAccCodeletDispatcherStart.

IX_STATUS ixCryptoAccCodeletDispatcherStart (BOOL useInterrupt)

This function starts the Queue manager dispatcher.

IX_STATUS ixCryptoAccCodeletRegisterCtx (INT32 srvIndex, IxCryptoAccCtx *pForwardCtx, IxCryptoAccCtx *pReverseCtx, UINT32 *pForwardCtxId, UINT32 *pReverseCtxId)

IX_STATUS ixCryptoAccCodeletPerform (UINT32 pktLen)

void ixCryptoAccCodeletUnregisterCtx (void)

This function unregisters all the contexts registered.

PRIVATE IX_STATUS ixCryptoAccCodeletXScaleWepPerform (IX_MBUF *pMbuf,UINT32 pktLen)

This codelet function calls ixCryptoAccXScaleWepPerform function to perform ARC4 or WEP_CRC processing on XScale.

IX_STATUS ixCryptoAccCodeletDispatcherStop (BOOL useInterrupt)

Stop QMgr dispatcher thread if QMgr dispatcher runs in poll mode or unbind QMgr dispatcher from interrupt if it runs in interrupt mode.

void ixCryptoAccCodeletUsageShow (void)

Display user guide for Linux platform or VxWorks platform.

Variables

BOOL forwardRegisterCBCalled

callback flag

BOOL reverseRegisterCBCalled

callback flag

IxCryptoAccRegisterCompleteCallback registerCB

register callback function

IxCryptoAccPerformCompleteCallback performCB

perform callback function

Detailed Description

This is private header file for the Crypto Access Component Codelet.

Date:: Jun-8-2003

Version:

Revision: 1.8

: -- Intel Copyright Notice --

: Copyright 2002-2003 Intel Corporation All Rights Reserved.

: The source code contained or described herein and all documents related to the source code ("Material") are owned by Intel Corporation or its suppliers or licensors. Title to the Material remains with Intel Corporation or its suppliers and licensors.

: The Material is protected by worldwide copyright and trade secret laws and treaty provisions. No part of the Material may be used, copied, reproduced, modified, published, uploaded, posted, transmitted, distributed, or disclosed in any way except in accordance with the applicable license agreement .

: No license under any patent, copyright, trade secret or other intellectual property right is granted to or conferred upon you by disclosure or delivery of the Materials, either expressly, by implication, inducement, estoppel, except in accordance with the applicable license agreement.

: Unless otherwise agreed by Intel in writing, you may not remove or alter this notice or any other notice embedded in Materials by Intel or Intel's suppliers or licensors in any way.

: For further details, please see the file README.TXT distributed with this software.

: -- End Intel Copyright Notice --

Definition in file IxCryptoAccCodelet_p.h.

Define Documentation

#define IX_CRYPTO_ACC_CODELET_DRV_DMA_FREE ( pData,
size )

To free the memory allocated through IX_CRYPTO_ACC_DRV_DMA_MALLOC function.

Note:
Example of usage: IX_CRYPTO_ACC_CODELET_DRV_DMA_FREE(pData, size)

Parameters:

UINT32 [in] *pData - memory block pointer to be freed.

UINT32 [in] size - size of memory block to be freed.

Returns:
None

Definition at line 152 of file IxCryptoAccCodelet_p.h.

#define IX_CRYPTOACC_CODELET_MAX_STR_SIZE

Maximum size of info string.

Definition at line 69 of file IxCryptoAccCodelet_p.h.

Function Documentation

ixCryptoAccCodeletBufIsQEmpty ( void )

This inline function is used to check whether the buffer queue is empty.

Parameters:

None

Returns:
BOOL

TRUE - the queue is full.
FALSE - the queue is not full.

ixCryptoAccCodeletBufIsQFull ( void )

This inline function is used to check whether the buffer queue is full.

Parameters:

None

Returns:
BOOL

TRUE - the queue is full.
FALSE - the queue is not full.

ixCryptoAccCodeletCryptoMbufFromQHeadRemove ( IX_MBUF ** pMbufToRem )

This function removes a mbuf from the head of the queue.

Parameters:

IX_MBUF** [in] pMbufToRem - Pointer to a mbuf pointer to be removed from the head of the queue.

Returns:
None.

ixCryptoAccCodeletCryptoMbufToQTailAdd ( IX_MBUF * pMbufToAdd )

This function adds a mbuf to the tail of the queue.

Parameters:

IX_MBUF* [in] pMbufToAdd - Pointer of the mbuf to be added to the tail of the queue.

Returns:
None.

IX_STATUS ixCryptoAccCodeletCryptoMemPoolFree ( UINT32 pktLen )

Free all resources in Crypto Access Codelet MBUF pool.

Parameters:

UINT32 [in] pktLen - packet length size for mbuf

Returns:
None

ixCryptoAccCodeletCryptoMemPoolInit ( UINT32 pktLen )

This function initialises mbuf pool for the Crypto Access Codelet.

Parameters:

UINT32 [in] pktLen - packet length size for mbuf

Returns:

IX_SUCCESS - Successful mbuf pool initialisation.

IX_FAIL - Mbuf pool initialisation failed.

ixCryptoAccCodeletDispatcherPoll ( void )

This function polls the queues when poll mode set in the function ixCryptoAccCodeletDispatcherStart.

Parameters:

None

Returns:
None

ixCryptoAccCodeletDispatcherStart ( BOOL useInterrupt )

This function starts the Queue manager dispatcher.

Parameters:

BOOL [in] useInterrupt - start in interrupt or poll mode. TRUE is interrupt mode while FALSE is poll mode.

Returns:

IX_SUCCESS - Dispatcher successfully started.

IX_FAIL - Error starting dispatcher.

ixCryptoAccCodeletDispatcherStop ( BOOL useInterrupt )

Stop QMgr dispatcher thread if QMgr dispatcher runs in poll mode or unbind QMgr dispatcher from interrupt if it runs in interrupt mode.

Parameters:

BOOL [in] useInterrupt - start in interrupt or poll mode. TRUE is interrupt mode while FALSE is poll mode.

Returns:

IX_SUCCESS - Dispatcher successfully stopped.

IX_FAIL - Error stopping dispatcher.

ixCryptoAccCodeletInit ( IxCryptoAccCfg ixCryptoAccCodeletCfg )

This function initialises the neccessary components.

Note:
The initialisation sequence is as follows:

Initialise Network Processor Engine(s) (NPE)

Initialise Queue manager

Start NPE(s)

Initialise Crypto Access component

Start Queue manager dispatcher.

Parameters:

IxCryptoAccCfg ixCryptoAccCodeletCfg - Specifies the interfaces to the engines that needs to be initialized.

Returns:

IX_SUCCESS - Successful initialization.

IX_FAIL - Initialization failed.

ixCryptoAccCodeletNpeInit ( IxNpeDlNpeId npeId,

IxNpeDlBuildId buildId

)

This function is to download the latest crypto NPE image into NPE.

Parameters:

IxNpeDlNpeId [in] npeId - The ID of the NPE which the microcode downloaded to.

IxNpeDlBuildId [in] buildId - The build ID for image which indicate functionality

Returns:

IX_SUCCESS - Successful NPE initialisation.

IX_FAIL - NPE initialisation failed.

ixCryptoAccCodeletUnregisterCtx ( void )

This function unregisters all the contexts registered.

Parameters:

None

Returns:
None

ixCryptoAccCodeletUsageShow ( void )

Display user guide for Linux platform or VxWorks platform.

Parameters:

None

Returns:
None

ixCryptoAccCodeletXScaleWepPerform ( IX_MBUF * pMbuf,

UINT32 pktLen

)

This codelet function calls ixCryptoAccXScaleWepPerform function to perform ARC4 or WEP_CRC processing on XScale.

Parameters:

IX_MBUF [in] *pMbuf : pointer to the mbuf

UINT32 [in] pktLen: length of data to be worked on.

Returns:

IX_SUCCESS - All invocations of ixCryptoAccXScaleWepPerform were succesful.

IX_FAIL - There was some kind of error while processing the request. This should not happen, if the codelet has been configured correctly.

Variable Documentation

BOOL forwardRegisterCBCalled

callback flag

Definition at line 60 of file IxCryptoAccCodelet_p.h.

IxCryptoAccPerformCompleteCallback performCB

perform callback function

Definition at line 65 of file IxCryptoAccCodelet_p.h.

IxCryptoAccRegisterCompleteCallback registerCB

register callback function

Definition at line 62 of file IxCryptoAccCodelet_p.h.

BOOL reverseRegisterCBCalled

callback flag

Definition at line 61 of file IxCryptoAccCodelet_p.h.