| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
PipeStream.h
Go to the documentation of this file.
1 /*
2 * @brief Pipe data stream transmission and reception management
3 *
4 * @note
5 * Copyright(C) NXP Semiconductors, 2012
6 * Copyright(C) Dean Camera, 2011, 2012
7 * All rights reserved.
8 *
9 * @par
10 * Software that is described herein is for illustrative purposes only
11 * which provides customers with programming information regarding the
12 * LPC products. This software is supplied "AS IS" without any warranties of
13 * any kind, and NXP Semiconductors and its licensor disclaim any and
14 * all warranties, express or implied, including all implied warranties of
15 * merchantability, fitness for a particular purpose and non-infringement of
16 * intellectual property rights. NXP Semiconductors assumes no responsibility
17 * or liability for the use of the software, conveys no license or rights under any
18 * patent, copyright, mask work right, or any other intellectual property rights in
19 * or to any products. NXP Semiconductors reserves the right to make changes
20 * in the software without notification. NXP Semiconductors also makes no
21 * representation or warranty that such application will be suitable for the
22 * specified use without further testing or modification.
23 *
24 * @par
25 * Permission to use, copy, modify, and distribute this software and its
26 * documentation is hereby granted, under NXP Semiconductors' and its
27 * licensor's relevant copyrights in the software, without fee, provided that it
28 * is used in conjunction with NXP Semiconductors microcontrollers. This
29 * copyright, permission, and disclaimer notice must appear in all copies of
30 * this code.
31 */
32
43 #ifndef __PIPE_STREAM_H__
44 #define __PIPE_STREAM_H__
45
46 /* Includes: */
47 #include "../../../Common/Common.h"
48 #include "USBMode.h"
49
50 /* Enable C linkage for C++ Compilers: */
51 #if defined(__cplusplus)
52 extern "C" {
53 #endif
54
55 /* Preprocessor Checks: */
56 #if !defined(__INCLUDE_FROM_USB_DRIVER)
57 #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
58 #endif
59
60 /* Public Interface - May be used in end-application: */
61 /* Enums: */
63 enum Pipe_Stream_RW_ErrorCodes_t
64 {
65 PIPE_RWSTREAM_NoError = 0,
66 PIPE_RWSTREAM_PipeStalled = 1,
67 PIPE_RWSTREAM_DeviceDisconnected = 2,
70 PIPE_RWSTREAM_Timeout = 3,
74 PIPE_RWSTREAM_IncompleteTransfer = 4,
77 };
78
79 #include "USBTask.h"
80 /* Function Prototypes: */
134 uint8_t Pipe_Discard_Stream(const uint8_t corenum,
135 uint16_t Length,
136 uint16_t *const BytesProcessed) /*ATTR_DEPRECATED*/;
137
188 uint8_t Pipe_Null_Stream(const uint8_t corenum,
189 uint16_t Length,
190 uint16_t *const BytesProcessed);
191
193
254 uint8_t Pipe_Write_Stream_LE(const uint8_t corenum,
255 const void *const Buffer,
256 uint16_t Length,
257 uint16_t *const BytesProcessed);
258
275 uint8_t Pipe_Write_Stream_BE(const void *const Buffer,
276 uint16_t Length,
277 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
278 "Function is not implemented yet");
279
338 uint8_t Pipe_Read_Stream_LE(const uint8_t corenum,
339 void *const Buffer,
340 uint16_t Length,
341 uint16_t *const BytesProcessed);
342
359 uint8_t Pipe_Read_Stream_BE(void *const Buffer,
360 uint16_t Length,
361 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
362 "Function is not implemented yet");
364
375 uint8_t Pipe_Write_EStream_LE(const void *const Buffer,
376 uint16_t Length,
377 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
378 "Function is not implemented yet");
379
388 uint8_t Pipe_Write_EStream_BE(const void *const Buffer,
389 uint16_t Length,
390 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
391 "Function is not implemented yet");
392
401 uint8_t Pipe_Read_EStream_LE(void *const Buffer,
402 uint16_t Length,
403 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
404 "Function is not implemented yet");
405
414 uint8_t Pipe_Read_EStream_BE(void *const Buffer,
415 uint16_t Length,
416 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
417 "Function is not implemented yet");
418
420
431 uint8_t Pipe_Write_PStream_LE(const void *const Buffer,
432 uint16_t Length,
433 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
434 "Function is not implemented yet");
435
444 uint8_t Pipe_Write_PStream_BE(const void *const Buffer,
445 uint16_t Length,
446 uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
447 "Function is not implemented yet");
448
457 uint8_t Pipe_Streaming(uint8_t corenum, uint8_t* const buffer, uint32_t const transferlength, uint16_t const packetsize);
458
460
461 /* Disable C linkage for C++ Compilers: */
462 #if defined(__cplusplus)
463 }
464 #endif
465
466 #endif
467