Skip to content

Use IPM for cdc-acm #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 16, 2017
Merged

Use IPM for cdc-acm #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 81 additions & 25 deletions cores/arduino/CDCSerialClass.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,35 @@
#include "wiring_digital.h"
#include "variant.h"

#define CDCACM_FIXED_DELAY 120
#define CDC_MAILBOX_TX_CHANNEL 7
#define CDC_MAILBOX_RX_CHANNEL 6

extern void CDCSerial_Handler(void);
extern void serialEventRun1(void) __attribute__((weak));
extern void serialEvent1(void) __attribute__((weak));

static void cdc_mbox_isr(CurieMailboxMsg msg)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function looks really complex for such a simple task. Can't you just do something like this;

unsigned char *ptr = (unsigned char*) msg.data;

/* Continue until 16 chars, or until NULL is seen */
for (unsigned i = 0; i < 16 && ptr[i]; ++i) {
    /* Assuming we have some kind of 'put' method for ring buffer... */
    ringbuffer_put(ptr[i]);
}

{
char *rxbuffptr = (char*)msg.data;
int new_head;
for(int i = 0; i < MBOX_BYTES; i++)
{
if((uint8_t)(*(rxbuffptr+i)) != '\0')
{
new_head = (Serial._rx_buffer->head +1) % CDCACM_BUFFER_SIZE;
if(new_head != Serial._rx_buffer->tail)
{
Serial._rx_buffer->data[Serial._rx_buffer->head] = *(rxbuffptr+i);
Serial._rx_buffer->head = new_head;
}
}
else
{
break;
}
}
}

// Constructors ////////////////////////////////////////////////////////////////

CDCSerialClass::CDCSerialClass(uart_init_info *info)
Expand All @@ -47,9 +70,9 @@ CDCSerialClass::CDCSerialClass(uart_init_info *info)

void CDCSerialClass::setSharedData(struct cdc_acm_shared_data *cdc_acm_shared_data)
{
this->_shared_data = cdc_acm_shared_data;
this->_rx_buffer = cdc_acm_shared_data->rx_buffer;
this->_tx_buffer = cdc_acm_shared_data->tx_buffer;
_shared_data = cdc_acm_shared_data;
_rx_buffer = cdc_acm_shared_data->rx_buffer;
_tx_buffer = cdc_acm_shared_data->tx_buffer;
}

void CDCSerialClass::begin(const uint32_t dwBaudRate)
Expand All @@ -73,7 +96,9 @@ void CDCSerialClass::init(const uint32_t dwBaudRate, const uint8_t modeReg)
* Empty the Rx buffer but don't touch Tx buffer: it is drained by the
* LMT one way or another */
_rx_buffer->tail = _rx_buffer->head;


mailbox_register(CDC_MAILBOX_RX_CHANNEL, cdc_mbox_isr);
mailbox_enable_receive(CDC_MAILBOX_RX_CHANNEL);
_shared_data->device_open = true;
}

Expand All @@ -84,12 +109,10 @@ void CDCSerialClass::end( void )

int CDCSerialClass::available( void )
{
#define SBS CDCACM_BUFFER_SIZE

if (!_shared_data->device_open)
return (0);
else
return (int)(SBS + _rx_buffer->head - _rx_buffer->tail) % SBS;
return (int)(CDCACM_BUFFER_SIZE + _rx_buffer->head - _rx_buffer->tail) % CDCACM_BUFFER_SIZE;
}

int CDCSerialClass::availableForWrite(void)
Expand Down Expand Up @@ -131,28 +154,61 @@ void CDCSerialClass::flush( void )
}
}

size_t CDCSerialClass::write( const uint8_t uc_data )
size_t CDCSerialClass::write(uint8_t uc_data )
{
uint32_t retries = 2;
CurieMailboxMsg cdcacm_msg;

if (!_shared_data->device_open || !_shared_data->host_open)
return(0);

do {
int i = (uint32_t)(_tx_buffer->head + 1) % CDCACM_BUFFER_SIZE;
// if we should be storing the received character into the location
// just before the tail (meaning that the head would advance to the
// current location of the tail), we're about to overflow the buffer
// and so we don't write the character or advance the head.
if (i != _tx_buffer->tail) {
_tx_buffer->data[_tx_buffer->head] = uc_data;
_tx_buffer->head = i;

// Just use a fixed delay to make it compatible with the CODK-M based firmware
delayMicroseconds(CDCACM_FIXED_DELAY);
break;
cdcacm_msg.channel = CDC_MAILBOX_TX_CHANNEL;
cdcacm_msg.data[0] = uc_data;
mailbox_write(cdcacm_msg);
delayMicroseconds(_writeDelayUsec);
return 1;
}

size_t CDCSerialClass::write(const uint8_t *buffer, size_t size)
{
CurieMailboxMsg cdcacm_msg;
cdcacm_msg.channel = CDC_MAILBOX_TX_CHANNEL;
if (!_shared_data->device_open || !_shared_data->host_open)
return(0);

int msg_len = size;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

msg_len never changes, why is it needed at all? just use size directly.


for(int i = 0;msg_len > 0; msg_len -= MBOX_BYTES, i += MBOX_BYTES)
{
/* Copy data into mailbox message */
memset(cdcacm_msg.data, 0, MBOX_BYTES);
if(msg_len >= MBOX_BYTES)
{
memcpy(cdcacm_msg.data, buffer+i, MBOX_BYTES);
}
} while (retries--);
else
{
memcpy(cdcacm_msg.data, buffer+i, msg_len);
}
/* Write to mailbox*/
mailbox_write(cdcacm_msg);
}

return 1;
// Mimick the throughput of a typical UART by throttling the data
// flow according to the configured baud rate
delayMicroseconds(_writeDelayUsec * size);

return size;
}

size_t CDCSerialClass::write(const char *str)
{
if (str == NULL) return 0;
CurieMailboxMsg cdcacm_msg;
cdcacm_msg.channel = CDC_MAILBOX_TX_CHANNEL;
if (!_shared_data->device_open || !_shared_data->host_open)
return(0);

int msg_len = strlen(str);

return write((const uint8_t *)str, msg_len);
}
11 changes: 7 additions & 4 deletions cores/arduino/CDCSerialClass.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include "HardwareSerial.h"
#include "platform.h"
#include "wiring.h"
#include "mailbox.h"

#include <board.h>
#include <uart.h>
Expand All @@ -36,6 +37,10 @@ class CDCSerialClass : public HardwareSerial
CDCSerialClass(uart_init_info *info);

void setSharedData(struct cdc_acm_shared_data *cdc_acm_shared_data);

struct cdc_acm_shared_data *_shared_data;
struct cdc_ring_buffer *_rx_buffer;
struct cdc_ring_buffer *_tx_buffer;

void begin(const uint32_t dwBaudRate);
void begin(const uint32_t dwBaudRate, const uint8_t config);
Expand All @@ -46,6 +51,8 @@ class CDCSerialClass : public HardwareSerial
int read(void);
void flush(void);
size_t write(const uint8_t c);
size_t write(const char *str);
size_t write(const uint8_t *buffer, size_t size);
using Print::write; // pull in write(str) and write(buf, size) from Print

operator bool() {
Expand All @@ -58,10 +65,6 @@ class CDCSerialClass : public HardwareSerial
protected:
void init(const uint32_t dwBaudRate, const uint8_t config);

struct cdc_acm_shared_data *_shared_data;
struct cdc_ring_buffer *_rx_buffer;
struct cdc_ring_buffer *_tx_buffer;

uart_init_info *info;
uint32_t _writeDelayUsec;
uint32_t _dwId;
Expand Down
2 changes: 1 addition & 1 deletion cores/arduino/Print.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class Print
void clearWriteError() { setWriteError(0); }

virtual size_t write(uint8_t) = 0;
size_t write(const char *str) {
virtual size_t write(const char *str) {
if (str == NULL) return 0;
return write((const uint8_t *)str, strlen(str));
}
Expand Down
1 change: 1 addition & 0 deletions cores/arduino/mailbox.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

#define NUM_MAILBOX_CHANNELS 8
#define CHANNEL_DATA_WORDS 4
#define MBOX_BYTES 16

class CurieMailboxMsg {
public:
Expand Down