kernel/eka/include/drivers/dma_v2.h
changeset 135 5e441a173c63
parent 132 e4a7b1cbe40c
child 189 a5496987b1da
equal deleted inserted replaced
134:95847726fe57 135:5e441a173c63
    68 
    68 
    69 	The EKA1 "Fill Mode" can be implemented by omitting KDmaIncSrc.
    69 	The EKA1 "Fill Mode" can be implemented by omitting KDmaIncSrc.
    70 
    70 
    71 	Some peripherals may require a post-increment address mode.
    71 	Some peripherals may require a post-increment address mode.
    72 
    72 
    73 	@see DDmaRequest::Fragment
    73 	@see DDmaRequest::Fragment()
    74 
    74 
    75 	Note: This enum is only required for backwards compatibility with the old
    75 	Note: This enum is only required for backwards compatibility with the old
    76 	DMA framework, it can be removed once this is no longer needed.
    76 	DMA framework, it can be removed once this is no longer needed.
    77 
    77 
    78 	@deprecated
    78 	@deprecated
   335 		operates on the source port descriptor chain.
   335 		operates on the source port descriptor chain.
   336 
   336 
   337 		Works like ExpandDesList except that it uses the iSrcFirstHdr and
   337 		Works like ExpandDesList except that it uses the iSrcFirstHdr and
   338 		iSrcLastHdr fields.
   338 		iSrcLastHdr fields.
   339 
   339 
   340 		@see ExpandDesList
   340 		@see ExpandDesList()
   341 
   341 
   342 		This function can only be used if SDmacCaps::iAsymHwDescriptors is
   342 		This function should only be used if SDmacCaps::iAsymHwDescriptors is
   343 		true, otherwise it will just return KErrGeneral.
   343 		reported as true, as only then the framework will actually use the
       
   344 		allocated descriptors.
   344 
   345 
   345 		@param aCount Number of descriptors to append.
   346 		@param aCount Number of descriptors to append.
   346 
   347 
   347 		@return KErrNone or standard error code.
   348 		@return KErrNone or standard error code.
   348 
   349 
   355 		operates on the destination port descriptor chain.
   356 		operates on the destination port descriptor chain.
   356 
   357 
   357 		Works like ExpandDesList except that it uses the iDstFirstHdr and
   358 		Works like ExpandDesList except that it uses the iDstFirstHdr and
   358 		iDstLastHdr fields.
   359 		iDstLastHdr fields.
   359 
   360 
   360 		@see ExpandDesList
   361 		@see ExpandDesList()
   361 
   362 
   362 		This function can only be used if SDmacCaps::iAsymHwDescriptors is
   363 		This function should only be used if SDmacCaps::iAsymHwDescriptors is
   363 		true, otherwise it will just return KErrGeneral.
   364 		reported as true, as only then the framework will actually use the
       
   365 		allocated descriptors.
   364 
   366 
   365 		@param aCount Number of descriptors to append.
   367 		@param aCount Number of descriptors to append.
   366 
   368 
   367 		@return KErrNone or standard error code.
   369 		@return KErrNone or standard error code.
   368 
   370 
   371 	IMPORT_C TInt ExpandDstDesList(TInt aCount=1);
   373 	IMPORT_C TInt ExpandDstDesList(TInt aCount=1);
   372 
   374 
   373 
   375 
   374 	/** Free resources associated with this request.
   376 	/** Free resources associated with this request.
   375 
   377 
   376 		Assume the request is not being transferred or pending.
   378 		Assumes the request is not being transferred or pending.
       
   379 
       
   380 		@see ExpandDesList()
   377 
   381 
   378 		@released
   382 		@released
   379 	*/
   383 	*/
   380 	IMPORT_C void FreeDesList();
   384 	IMPORT_C void FreeDesList();
   381 
   385 
   382 
   386 
   383 	/** Free resources associated with this request. This function variant
   387 	/** Free resources associated with this request. This function variant
   384 		operates on the source port descriptor chain.
   388 		operates on the source port descriptor chain.
   385 
   389 
   386 		@see FreeDesList
   390 		Assumes the request is not being transferred or pending.
   387 
   391 
   388 		This function can only be used if SDmacCaps::iAsymHwDescriptors is
   392 		@see ExpandSrcDesList()
   389 		true, otherwise it will do nothing.
       
   390 
   393 
   391 		@prototype
   394 		@prototype
   392 	*/
   395 	*/
   393 	IMPORT_C void FreeSrcDesList();
   396 	IMPORT_C void FreeSrcDesList();
   394 
   397 
   395 
   398 
   396 	/** Free resources associated with this request. This function variant
   399 	/** Free resources associated with this request. This function variant
   397 		operates on the destination port descriptor chain.
   400 		operates on the destination port descriptor chain.
   398 
   401 
   399 		@see FreeDesList
   402 		Assumes the request is not being transferred or pending.
   400 
   403 
   401 		This function can only be used if SDmacCaps::iAsymHwDescriptors is
   404 		@see ExpandDstDesList()
   402 		true, otherwise it will do nothing.
       
   403 
   405 
   404 		@prototype
   406 		@prototype
   405 	*/
   407 	*/
   406 	IMPORT_C void FreeDstDesList();
   408 	IMPORT_C void FreeDstDesList();
   407 
   409