![]() |
LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
|
Endpoint data stream transmission and reception management for the NXP LPC architecture. More...
Stream functions for null data | |
uint8_t | Endpoint_Discard_Stream (uint16_t Length, uint16_t *const BytesProcessed) |
Reads and discards the given number of bytes from the currently selected endpoint's bank, 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 host via the Endpoint_ClearOUT() macro. | |
uint8_t | Endpoint_Null_Stream (uint16_t Length, uint16_t *const BytesProcessed) |
Writes a given number of zeroed bytes to the currently selected endpoint's bank, sending full packets to the host as needed. The last packet is not automatically sent once the remaining bytes have been written; the user is responsible for manually sending the last packet to the host via the Endpoint_ClearIN() macro. | |
Stream functions for RAM source/destination data | |
uint8_t | Endpoint_Write_Stream_LE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Writes the given number of bytes to the endpoint from the given buffer in little endian, sending full packets to the host 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 Endpoint_ClearIN() macro. | |
uint8_t | Endpoint_Write_Stream_BE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Writes the given number of bytes to the endpoint from the given buffer in big endian, sending full packets to the host 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 Endpoint_ClearIN() macro. | |
uint8_t | Endpoint_Read_Stream_LE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Reads the given number of bytes from the endpoint from the given buffer in little endian, 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 host via the Endpoint_ClearOUT() macro. | |
uint8_t | Endpoint_Read_Stream_BE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Reads the given number of bytes from the endpoint from the given buffer in big endian, 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 host via the Endpoint_ClearOUT() macro. | |
uint8_t | Endpoint_Write_Control_Stream_LE (const void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian, sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared in both failure and success states; the user is responsible for manually clearing the setup OUT to finalize the transfer via the Endpoint_ClearOUT() macro. | |
uint8_t | Endpoint_Write_Control_Stream_BE (const void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian, sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared in both failure and success states; the user is responsible for manually clearing the setup OUT to finalize the transfer via the Endpoint_ClearOUT() macro. | |
uint8_t | Endpoint_Read_Control_Stream_LE (void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian, discarding fully read packets from the host as needed. The device IN acknowledgement is not automatically sent after success or failure states; the user is responsible for manually sending the setup IN to finalize the transfer via the Endpoint_ClearIN() macro. | |
uint8_t | Endpoint_Read_Control_Stream_BE (void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian, discarding fully read packets from the host as needed. The device IN acknowledgement is not automatically sent after success or failure states; the user is responsible for manually sending the setup IN to finalize the transfer via the Endpoint_ClearIN() macro. | |
Stream functions for EEPROM source/destination data | |
uint8_t | Endpoint_Write_EStream_LE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write EEPROM Stream Little Endian. | |
uint8_t | Endpoint_Write_EStream_BE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write EEPROM Stream Big Endian. | |
uint8_t | Endpoint_Read_EStream_LE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Read EEPROM Stream Little Endian. | |
uint8_t | Endpoint_Read_EStream_BE (void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Read EEPROM Stream Big Endian. | |
uint8_t | Endpoint_Write_Control_EStream_LE (const void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write Control EEPROM Stream Little Endian. | |
uint8_t | Endpoint_Write_Control_EStream_BE (const void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write Control EEPROM Stream Big Endian. | |
uint8_t | Endpoint_Read_Control_EStream_LE (void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Read Control EEPROM Stream Little Endian. | |
uint8_t | Endpoint_Read_Control_EStream_BE (void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Read Control EEPROM Stream Big Endian. | |
uint8_t | Endpoint_Write_PStream_LE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write PROGMEM Stream Little Endian. | |
uint8_t | Endpoint_Write_PStream_BE (const void *const Buffer, uint16_t Length, uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write PROGMEM Stream Big Endian. | |
uint8_t | Endpoint_Write_Control_PStream_LE (const void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write Control PROGMEM Stream Little Endian. | |
uint8_t | Endpoint_Write_Control_PStream_BE (const void *const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) |
Endpoint Write Control PROGMEM Stream Big Endian. | |
Endpoint data stream transmission and reception management for the NXP LPC architecture.
Functions, macros, variables, enums and types related to data reading and writing of data streams from and to endpoints.
uint8_t Endpoint_Discard_Stream | ( | uint16_t | Length, |
uint16_t *const | BytesProcessed | ||
) |
Reads and discards the given number of bytes from the currently selected endpoint's bank, 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 host via the Endpoint_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 endpoint 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 ENDPOINT_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:
Length | Number of bytes to discard via the currently selected endpoint. |
BytesProcessed | Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once. |
Length | : Number of bytes to discard via the currently selected endpoint |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once. |
Definition at line 40 of file EndpointStream_LPC.c.
uint8_t Endpoint_Null_Stream | ( | uint16_t | Length, |
uint16_t *const | BytesProcessed | ||
) |
Writes a given number of zeroed bytes to the currently selected endpoint's bank, sending full packets to the host as needed. The last packet is not automatically sent once the remaining bytes have been written; the user is responsible for manually sending the last packet to the host via the Endpoint_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 endpoint 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 ENDPOINT_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:
Length | Number of zero bytes to send via the currently selected endpoint. |
BytesProcessed | Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once. |
Length | : Number of zero bytes to send via the currently selected endpoint |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once |
Definition at line 49 of file EndpointStream_LPC.c.
uint8_t Endpoint_Read_Control_EStream_BE | ( | void *const | Buffer, |
uint16_t | Length | ||
) |
Endpoint Read Control EEPROM Stream Big Endian.
Buffer | : Pointer to the destination data buffer to write to |
Length | : Number of bytes to send via the currently selected endpoint |
uint8_t Endpoint_Read_Control_EStream_LE | ( | void *const | Buffer, |
uint16_t | Length | ||
) |
Endpoint Read Control EEPROM Stream Little Endian.
Buffer | : Pointer to the destination data buffer to write to |
Length | : Number of bytes to send via the currently selected endpoint |
uint8_t Endpoint_Read_Control_Stream_BE | ( | void *const | Buffer, |
uint16_t | Length | ||
) |
Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian, discarding fully read packets from the host as needed. The device IN acknowledgement is not automatically sent after success or failure states; the user is responsible for manually sending the setup IN to finalize the transfer via the Endpoint_ClearIN() macro.
Buffer | : Pointer to the destination data buffer to write to |
Length | : Number of bytes to send via the currently selected endpoint |
Definition at line 148 of file EndpointStream_LPC.c.
uint8_t Endpoint_Read_Control_Stream_LE | ( | void *const | Buffer, |
uint16_t | Length | ||
) |
Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian, discarding fully read packets from the host as needed. The device IN acknowledgement is not automatically sent after success or failure states; the user is responsible for manually sending the setup IN to finalize the transfer via the Endpoint_ClearIN() macro.
Buffer | : Pointer to the destination data buffer to write to |
Length | : Number of bytes to send via the currently selected endpoint |
Definition at line 139 of file EndpointStream_LPC.c.
uint8_t Endpoint_Read_EStream_BE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Endpoint Read EEPROM Stream Big Endian.
Buffer | : Pointer to the destination data buffer to write to, located in EEPROM memory space |
Length | : Number of bytes to send via the currently selected endpoint |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once |
uint8_t Endpoint_Read_EStream_LE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Endpoint Read EEPROM Stream Little Endian.
Buffer | : Pointer to the destination data buffer to write to, located in EEPROM memory space |
Length | : Number of bytes to send via the currently selected endpoint |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once |
uint8_t Endpoint_Read_Stream_BE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Reads the given number of bytes from the endpoint from the given buffer in big endian, 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 host via the Endpoint_ClearOUT() macro.
Buffer | : Pointer to the destination data buffer to write to |
Length | : Number of bytes to send via the currently selected endpoint |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once |
Definition at line 113 of file EndpointStream_LPC.c.
uint8_t Endpoint_Read_Stream_LE | ( | void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Reads the given number of bytes from the endpoint from the given buffer in little endian, 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 host via the Endpoint_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 endpoint 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 ENDPOINT_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:
[out] | Buffer | Pointer to the destination data buffer to write to. |
Length | Number of bytes to send via the currently selected endpoint. | |
BytesProcessed | Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be read at once. | |
Buffer | : Pointer to the destination data buffer to write to | |
Length | : Number of bytes to send via the currently selected endpoint | |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once |
Definition at line 88 of file EndpointStream_LPC.c.
uint8_t Endpoint_Write_Control_EStream_BE | ( | const void *const | Buffer, |
uint16_t | Length | ||
) |
Endpoint Write Control EEPROM Stream Big Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
uint8_t Endpoint_Write_Control_EStream_LE | ( | const void *const | Buffer, |
uint16_t | Length | ||
) |
Endpoint Write Control EEPROM Stream Little Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
uint8_t Endpoint_Write_Control_PStream_BE | ( | const void *const | Buffer, |
uint16_t | Length | ||
) |
Endpoint Write Control PROGMEM Stream Big Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
uint8_t Endpoint_Write_Control_PStream_LE | ( | const void *const | Buffer, |
uint16_t | Length | ||
) |
Endpoint Write Control PROGMEM Stream Little Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
uint8_t Endpoint_Write_Control_Stream_BE | ( | const void *const | Buffer, |
uint16_t | Length | ||
) |
Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian, sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared in both failure and success states; the user is responsible for manually clearing the setup OUT to finalize the transfer via the Endpoint_ClearOUT() macro.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
Definition at line 133 of file EndpointStream_LPC.c.
uint8_t Endpoint_Write_Control_Stream_LE | ( | const void *const | Buffer, |
uint16_t | Length | ||
) |
Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian, sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared in both failure and success states; the user is responsible for manually clearing the setup OUT to finalize the transfer via the Endpoint_ClearOUT() macro.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
Definition at line 122 of file EndpointStream_LPC.c.
uint8_t Endpoint_Write_EStream_BE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Endpoint 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 endpoint into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once |
uint8_t Endpoint_Write_EStream_LE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Endpoint 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 endpoint into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once |
uint8_t Endpoint_Write_PStream_BE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Endpoint Write PROGMEM Stream Big Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once. |
uint8_t Endpoint_Write_PStream_LE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Endpoint Write PROGMEM Stream Little Endian.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once. |
uint8_t Endpoint_Write_Stream_BE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Writes the given number of bytes to the endpoint from the given buffer in big endian, sending full packets to the host 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 Endpoint_ClearIN() macro.
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once |
Definition at line 77 of file EndpointStream_LPC.c.
uint8_t Endpoint_Write_Stream_LE | ( | const void *const | Buffer, |
uint16_t | Length, | ||
uint16_t *const | BytesProcessed | ||
) |
Writes the given number of bytes to the endpoint from the given buffer in little endian, sending full packets to the host 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 Endpoint_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 endpoint 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 ENDPOINT_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:
Buffer | Pointer to the source data buffer to read from. |
Length | Number of bytes to read for the currently selected endpoint into the buffer. |
BytesProcessed | Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once. |
Buffer | : Pointer to the source data buffer to read from |
Length | : Number of bytes to read for the currently selected endpoint into the buffer |
BytesProcessed | : Pointer to a location where the total number of bytes processed in the current transaction should be updated, NULL if the entire stream should be written at once |
Definition at line 62 of file EndpointStream_LPC.c.