![]() |
LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
|
Pipe data stream transmission and reception management for the LPC architecture. More...
Stream functions for null data | |
uint8_t | Pipe_Discard_Stream (const uint8_t corenum, uint16_t Length, uint16_t *const BytesProcessed) |
Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host as needed. The last packet is not automatically discarded once the remaining bytes has been read; the user is responsible for manually discarding the last packet from the device via the Pipe_ClearIN() macro. | |
uint8_t | Pipe_Null_Stream (const uint8_t corenum, uint16_t Length, uint16_t *const BytesProcessed) |
Writes a given number of zeroed bytes to the pipe, sending full pipe packets from the host to the device as needed. The last packet is not automatically sent once the remaining bytes has been written; the user is responsible for manually discarding the last packet from the device via the Pipe_ClearOUT() macro. | |
Stream functions for RAM source/destination data | |
uint8_t | Pipe_Write_Stream_LE (const uint8_t corenum, const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) |
Writes the given number of bytes to the pipe from the given buffer in little endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. | |
uint8_t | Pipe_Write_Stream_BE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Writes the given number of bytes to the pipe from the given buffer in big endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. | |
uint8_t | Pipe_Read_Stream_LE (const uint8_t corenum, void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) |
Reads the given number of bytes from the pipe into the given buffer in little endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. | |
uint8_t | Pipe_Read_Stream_BE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Reads the given number of bytes from the pipe into the given buffer in big endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. | |
Stream functions for EEPROM source/destination data | |
uint8_t | Pipe_Write_EStream_LE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Pipe Write EEPROM Stream Little Endian. | |
uint8_t | Pipe_Write_EStream_BE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Pipe Write EEPROM Stream Big Endian. | |
uint8_t | Pipe_Read_EStream_LE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Pipe Read EEPROM Stream Little Endian. | |
uint8_t | Pipe_Read_EStream_BE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Pipe Read EEPROM Stream Big Endian. | |
Stream functions for PROGMEM source/destination data | |
uint8_t | Pipe_Write_PStream_LE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Pipe Write FLASH Stream Little Endian. | |
uint8_t | Pipe_Write_PStream_BE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR("Function is not implemented yet") |
Pipe Write FLASH Stream Big Endian. | |
Pipe data stream transmission and reception management for the LPC architecture.
Functions, macros, variables, enums and types related to data reading and writing of data streams from and to pipes.
uint8_t Pipe_Discard_Stream | ( | const uint8_t | corenum, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host as needed. The last packet is not automatically discarded once the remaining bytes has been read; the user is responsible for manually discarding the last packet from the device via the Pipe_ClearIN() macro.
If the BytesProcessed parameter is NULL
, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes empty while there is still data to process (and after the current packet has been acknowledged) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.
Single Stream Transfer Example:
Partial Stream Transfers Example:
corenum | : USB port number |
Length | : Number of bytes to discard via the currently selected pipe |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be processed at once. |
Definition at line 39 of file PipeStream_LPC.c.
uint8_t Pipe_Null_Stream | ( | const uint8_t | corenum, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Writes a given number of zeroed bytes to the pipe, sending full pipe packets from the host to the device as needed. The last packet is not automatically sent once the remaining bytes has been written; the user is responsible for manually discarding the last packet from the device via the Pipe_ClearOUT() macro.
If the BytesProcessed parameter is NULL
, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes full while there is still data to process (and after the current packet transmission has been initiated) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.
Single Stream Transfer Example:
Partial Stream Transfers Example:
corenum | : USB port number |
Length | : Number of zero bytes to write via the currently selected pipe |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be processed at once. |
Definition at line 80 of file PipeStream_LPC.c.
uint8_t Pipe_Read_EStream_BE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Pipe Read EEPROM Stream Big Endian.
Buffer | : Pointer to the source data buffer to write to |
Length | : Number of bytes to read for the currently selected pipe to read from |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be read at once. |
Definition at line 205 of file PipeStream_LPC.c.
uint8_t Pipe_Read_EStream_LE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Pipe Read EEPROM Stream Little Endian.
Buffer | : Pointer to the source data buffer to write to |
Length | : Number of bytes to read for the currently selected pipe to read from |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be read at once. |
Definition at line 198 of file PipeStream_LPC.c.
uint8_t Pipe_Read_Stream_BE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Reads the given number of bytes from the pipe into the given buffer in big endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
Buffer | : Pointer to the source data buffer to write to |
Length | : Number of bytes to read for the currently selected pipe to read from |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be read at once. |
Definition at line 163 of file PipeStream_LPC.c.
uint8_t Pipe_Read_Stream_LE | ( | const uint8_t | corenum, |
void *const | Buffer, | ||
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Reads the given number of bytes from the pipe into the given buffer in little endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
If the BytesProcessed parameter is NULL
, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes empty while there is still data to process (and after the current packet has been acknowledged) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.
Single Stream Transfer Example:
Partial Stream Transfers Example:
corenum | : USB port number |
Buffer | : Pointer to the source data buffer to write to |
Length | : Number of bytes to read for the currently selected pipe to read from |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be read at once. |
Definition at line 116 of file PipeStream_LPC.c.
uint8_t Pipe_Write_EStream_BE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Pipe Write EEPROM Stream Big Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected pipe into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be written at once. |
Definition at line 191 of file PipeStream_LPC.c.
uint8_t Pipe_Write_EStream_LE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Pipe Write EEPROM Stream Little Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected pipe into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be written at once. |
Definition at line 184 of file PipeStream_LPC.c.
uint8_t Pipe_Write_PStream_BE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Pipe Write FLASH Stream Big Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected pipe into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be written at once. |
Definition at line 177 of file PipeStream_LPC.c.
uint8_t Pipe_Write_PStream_LE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Pipe Write FLASH Stream Little Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected pipe into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be written at once. |
Definition at line 170 of file PipeStream_LPC.c.
uint8_t Pipe_Write_Stream_BE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Writes the given number of bytes to the pipe from the given buffer in big endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected pipe into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be written at once. |
Definition at line 156 of file PipeStream_LPC.c.
uint8_t Pipe_Write_Stream_LE | ( | const uint8_t | corenum, |
const void *const | Buffer, | ||
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Writes the given number of bytes to the pipe from the given buffer in little endian, sending full packets to the device as needed. The last packet filled is not automatically sent; the user is responsible for manually sending the last written packet to the host via the Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
If the BytesProcessed parameter is NULL
, the entire stream transfer is attempted at once, failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer will instead be performed as a series of chunks. Each time the pipe bank becomes full while there is still data to process (and after the current packet transmission has been initiated) the BytesProcessed location will be updated with the total number of bytes processed in the stream, and the function will exit with an error code of PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed value reaches the total transfer length.
Single Stream Transfer Example:
Partial Stream Transfers Example:
corenum | : USB port number |
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected pipe into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes already processed should updated, NULL if the entire stream should be written at once. |
Definition at line 96 of file PipeStream_LPC.c.