LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
PipeStream_LPC.h
Go to the documentation of this file.
1 /*
2  * @brief Pipe data stream transmission and reception management for the LPC microcontrollers
3  *
4  * @note
5  * Copyright(C) NXP Semiconductors, 2012
6  * All rights reserved.
7  *
8  * @par
9  * Software that is described herein is for illustrative purposes only
10  * which provides customers with programming information regarding the
11  * LPC products. This software is supplied "AS IS" without any warranties of
12  * any kind, and NXP Semiconductors and its licensor disclaim any and
13  * all warranties, express or implied, including all implied warranties of
14  * merchantability, fitness for a particular purpose and non-infringement of
15  * intellectual property rights. NXP Semiconductors assumes no responsibility
16  * or liability for the use of the software, conveys no license or rights under any
17  * patent, copyright, mask work right, or any other intellectual property rights in
18  * or to any products. NXP Semiconductors reserves the right to make changes
19  * in the software without notification. NXP Semiconductors also makes no
20  * representation or warranty that such application will be suitable for the
21  * specified use without further testing or modification.
22  *
23  * @par
24  * Permission to use, copy, modify, and distribute this software and its
25  * documentation is hereby granted, under NXP Semiconductors' and its
26  * licensor's relevant copyrights in the software, without fee, provided that it
27  * is used in conjunction with NXP Semiconductors microcontrollers. This
28  * copyright, permission, and disclaimer notice must appear in all copies of
29  * this code.
30  */
31 
41 #ifndef __PIPE_STREAM_LPC_H__
42 #define __PIPE_STREAM_LPC_H__
43 
44 /* Includes: */
45  #include "../../../../Common/Common.h"
46  #include "../USBMode.h"
47  #include "../USBTask.h"
48 
49 /* Enable C linkage for C++ Compilers: */
50  #if defined(__cplusplus)
51 extern "C" {
52  #endif
53 
54 /* Preprocessor Checks: */
55  #if !defined(__INCLUDE_FROM_USB_DRIVER)
56  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
57  #endif
58 
59 /* Public Interface - May be used in end-application: */
60 /* Function Prototypes: */
114 uint8_t Pipe_Discard_Stream(const uint8_t corenum,
115  uint16_t Length,
116  uint16_t *const BytesProcessed) /*ATTR_DEPRECATED*/;
117 
168 uint8_t Pipe_Null_Stream(const uint8_t corenum,
169  uint16_t Length,
170  uint16_t *const BytesProcessed);
171 
173 
234 uint8_t Pipe_Write_Stream_LE(const uint8_t corenum,
235  const void *const Buffer,
236  uint16_t Length,
237  uint16_t *const BytesProcessed);
238 
255 uint8_t Pipe_Write_Stream_BE(const void *const Buffer,
256  uint16_t Length,
257  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
258  "Function is not implemented yet");
259 
318 uint8_t Pipe_Read_Stream_LE(const uint8_t corenum,
319  void *const Buffer,
320  uint16_t Length,
321  uint16_t *const BytesProcessed);
322 
339 uint8_t Pipe_Read_Stream_BE(void *const Buffer,
340  uint16_t Length,
341  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
342  "Function is not implemented yet");
344 
355 uint8_t Pipe_Write_EStream_LE(const void *const Buffer,
356  uint16_t Length,
357  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
358  "Function is not implemented yet");
359 
368 uint8_t Pipe_Write_EStream_BE(const void *const Buffer,
369  uint16_t Length,
370  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
371  "Function is not implemented yet");
372 
381 uint8_t Pipe_Read_EStream_LE(void *const Buffer,
382  uint16_t Length,
383  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
384  "Function is not implemented yet");
385 
394 uint8_t Pipe_Read_EStream_BE(void *const Buffer,
395  uint16_t Length,
396  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
397  "Function is not implemented yet");
398 
400 
411 uint8_t Pipe_Write_PStream_LE(const void *const Buffer,
412  uint16_t Length,
413  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
414  "Function is not implemented yet");
415 
424 uint8_t Pipe_Write_PStream_BE(const void *const Buffer,
425  uint16_t Length,
426  uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
427  "Function is not implemented yet");
429 
430 /* Disable C linkage for C++ Compilers: */
431  #if defined(__cplusplus)
432 }
433  #endif
434 
435 #endif
436