Skip to content
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

Jump to bottom

Some Serial object fixes... #2

Merged
merged 4 commits into from
Dec 9, 2024
Merged

Some Serial object fixes... #2

merged 4 commits into from
Dec 9, 2024

Conversation

KurtE
Copy link

@KurtE KurtE commented Nov 29, 2024

added availableForWrite - overwrite Print virtual - get it from ring buffer

fix peek and Read, that if 0 bytes read from ring buffer return -1

begin method appeared to have initial garbage in it. so have it call ring_buf_reset on the rx ring buffer

Test sketch is setup for Serial1-4 which is working.

in the overlay file I added:

&usart2 {
	status = "okay";
	pinctrl-0 = <&usart2_tx_pd5 &usart2_rx_pd6>;
	pinctrl-names = "default";
	current-speed = <115200>;
};

&uart4 {
	status = "okay";
	pinctrl-0 = <&uart4_tx_ph13 &uart4_rx_pi9>;
	pinctrl-names = "default";
	current-speed = <115200>;
};

and changed serials to:
serials = <&cdc_acm_uart0>, <&usart1>, <&usart2>, <&uart4>, <&usart6>;

Test sketch:

//connect  Serial1 TX -> Serial2 RX, Serial2 TX -> Serial3 RX, Serial3 TX -> Serial4 RX....
#define USE_SERIAL2
#define USE_SERIAL3
#define USE_SERIAL4

#define SPD 9600
int loop_count = 0;

#define BUFFER_SIZE 80

class BufferInfoClass {
public:
  BufferInfoClass() {
    clear();
  }
  char buffer[BUFFER_SIZE];
  uint8_t cb_buffer;
  uint8_t cb_copy[BUFFER_SIZE];
  uint8_t cb_copy_cnt;
  void clear() {
    cb_buffer = 0;
    cb_copy_cnt = 0;
  }
};

BufferInfoClass buffers[5];
uint32_t millis_last_input = 0;

void setup() {
  pinMode(LED_BUILTIN, OUTPUT);
  digitalWrite(LED_BUILTIN, LOW);
  while (!Serial && millis() < 4000)
    ;
  Serial.begin(9600);
  delay(800);
  Serial.println("Test all Serials");
  Serial.print("Baud rate: ");
  Serial.println(SPD, DEC);
  wait_for_user_input();
  Serial1.begin(SPD);
  Serial1.println("Serial1 started");
#ifdef USE_SERIAL2
  //wait_for_user_input();
  Serial2.begin(SPD);
  Serial2.println("Serial2 started");
#endif
#ifdef USE_SERIAL3
  //wait_for_user_input();
  Serial3.begin(SPD);
  Serial3.println("Serial3 started");
#endif
#ifdef USE_SERIAL4
  //wait_for_user_input();
  Serial4.begin(SPD);
  Serial4.println("Serial4 started");
#endif
  wait_for_user_input();
}

void wait_for_user_input() {
  Serial.println("Waiting...");
#if 0
  while (!Serial.available()) {}
  while (Serial.available()) {Serial.read();}
#else
  while (Serial.read() == -1) {};
  while (Serial.read() != -1) {};
#endif
}

#define MIN(a, b) ((a) <= (b) ? (a) : (b))


void CopyFromTo(Stream &SerialF, Stream &SerialT, uint8_t buffer_index) {
  int available;
  int available_for_write;
  int cb;
  BufferInfoClass *buf = &buffers[buffer_index];
  if ((available = SerialF.available()) != 0) {
    //Serial.print(buffer_index, DEC);
    //Serial.print(":Avail: ");
    //Serial.print(available, DEC);//connect  Serial1 TX -> Serial2 RX, Serial2 TX -> Serial3 RX, Serial3 TX -> Serial4 RX....
#define USE_SERIAL2
#define USE_SERIAL3
#define USE_SERIAL4

#define SPD 9600
int loop_count = 0;

#define BUFFER_SIZE 80

class BufferInfoClass {
public:
  BufferInfoClass() {
    clear();
  }
  char buffer[BUFFER_SIZE];
  uint8_t cb_buffer;
  uint8_t cb_copy[BUFFER_SIZE];
  uint8_t cb_copy_cnt;
  void clear() {
    cb_buffer = 0;
    cb_copy_cnt = 0;
  }
};

BufferInfoClass buffers[5];
uint32_t millis_last_input = 0;

void setup() {
  pinMode(LED_BUILTIN, OUTPUT);
  digitalWrite(LED_BUILTIN, LOW);
  while (!Serial && millis() < 4000)
    ;
  Serial.begin(9600);
  delay(800);
  Serial.println("Test all Serials");
  Serial.print("Baud rate: ");
  Serial.println(SPD, DEC);
  wait_for_user_input();
  Serial1.begin(SPD);
  Serial1.println("Serial1 started");
#ifdef USE_SERIAL2
  //wait_for_user_input();
  Serial2.begin(SPD);
  Serial2.println("Serial2 started");
#endif
#ifdef USE_SERIAL3
  //wait_for_user_input();
  Serial3.begin(SPD);
  Serial3.println("Serial3 started");
#endif
#ifdef USE_SERIAL4
  //wait_for_user_input();
  Serial4.begin(SPD);
  Serial4.println("Serial4 started");
#endif
  wait_for_user_input();
}

void wait_for_user_input() {
  Serial.println("Waiting...");
#if 0
  while (!Serial.available()) {}
  while (Serial.available()) {Serial.read();}
#else
  while (Serial.read() == -1) {};
  while (Serial.read() != -1) {};
#endif
}

#define MIN(a, b) ((a) <= (b) ? (a) : (b))


void CopyFromTo(Stream &SerialF, Stream &SerialT, uint8_t buffer_index) {
  int available;
  int available_for_write;
  int cb;
  BufferInfoClass *buf = &buffers[buffer_index];
  if ((available = SerialF.available()) != 0) {
    //Serial.print(buffer_index, DEC);
    //Serial.print(":Avail: ");
    //Serial.print(available, DEC);
    available_for_write = SerialT.availableForWrite();
    //Serial.print(" ");
    //Serial.println(available_for_write, DEC);
    cb = MIN(MIN(available, available_for_write), BUFFER_SIZE);
    if (cb) {
      SerialF.readBytes(&buf->buffer[buf->cb_buffer], cb);
      SerialT.write(&buf->buffer[buf->cb_buffer], cb);
      buf->cb_buffer += cb;
      buf->cb_copy[buf->cb_copy_cnt] = cb;
      buf->cb_copy_cnt++;
      millis_last_input = millis();
    }
  }
}

void memory_dump(const char *pb, uint8_t cb) {
  const char *pbA = pb;
  uint8_t cbA = cb;

  Serial.print("\t");
  for (uint8_t i = 0; i < cb; i++) {
    if (*pb < 0x10) Serial.write('0');
    Serial.print(*pb, HEX);
    Serial.print(" ");
    pb++;
  }

  Serial.print("\n\t ");
  for (uint8_t i = 0; i < cbA; i++) {
    if (*pbA >= ' ') Serial.write(*pbA);
    else Serial.write(' ');
    Serial.print("  ");
    pbA++;
  }
  Serial.println();
}

void print_buffer_header(uint8_t index) {
  BufferInfoClass *buf = &buffers[index];
  Serial.print("  ");
  Serial.print(buf->cb_buffer, DEC);
  Serial.print(" (");
  for (uint8_t i = 0; i < buf->cb_copy_cnt; i++) {
    if (i != 0) Serial.print(",");
    Serial.print(buf->cb_copy[i], DEC);
  }
  Serial.print(")");
}

void CompareBuffers(uint8_t index1, uint8_t index2) {
  if (buffers[index1].cb_buffer == buffers[index2].cb_buffer) {
    if (memcmp(buffers[index1].buffer, buffers[index2].buffer, buffers[index1].cb_buffer) == 0) {
      Serial.println(" ** Match **");
      return;
    } else {
      Serial.println(" ** different **");
    }
  } else {
    Serial.println(" ** counts different **");
  }
  memory_dump(buffers[index1].buffer, buffers[index1].cb_buffer);
  memory_dump(buffers[index2].buffer, buffers[index2].cb_buffer);
}

void loop() {
  CopyFromTo(Serial, Serial1, 0);
  CopyFromTo(Serial1, Serial, 1);
#ifdef USE_SERIAL2
  CopyFromTo(Serial2, Serial2, 2);
#endif
#ifdef USE_SERIAL3
  CopyFromTo(Serial3, Serial3, 3);
#endif
#ifdef USE_SERIAL4
  CopyFromTo(Serial4, Serial4, 4);
#endif

  // now see if we should compare the data yet or not
  if (buffers[0].cb_buffer && ((millis() - millis_last_input) > 100)) {
    Serial.println("Check buffers: ");

    print_buffer_header(0);
    Serial.println();

    for (uint8_t i = 1; i < 5; i++) {
      print_buffer_header(i);
      CompareBuffers(0, i);
    }
    for (uint8_t i = 0; i < 5; i++) buffers[i].clear();
  }

  digitalWrite(LED_BUILTIN, HIGH);
  delayMicroseconds(100);  // give time form things to propagate
  digitalWrite(LED_BUILTIN, LOW);
}

    available_for_write = SerialT.availableForWrite();
    //Serial.print(" ");
    //Serial.println(available_for_write, DEC);
    cb = MIN(MIN(available, available_for_write), BUFFER_SIZE);
    if (cb) {
      SerialF.readBytes(&buf->buffer[buf->cb_buffer], cb);
      SerialT.write(&buf->buffer[buf->cb_buffer], cb);
      buf->cb_buffer += cb;
      buf->cb_copy[buf->cb_copy_cnt] = cb;
      buf->cb_copy_cnt++;
      millis_last_input = millis();
    }
  }
}

void memory_dump(const char *pb, uint8_t cb) {
  const char *pbA = pb;
  uint8_t cbA = cb;

  Serial.print("\t");
  for (uint8_t i = 0; i < cb; i++) {
    if (*pb < 0x10) Serial.write('0');
    Serial.print(*pb, HEX);
    Serial.print(" ");
    pb++;
  }

  Serial.print("\n\t ");
  for (uint8_t i = 0; i < cbA; i++) {
    if (*pbA >= ' ') Serial.write(*pbA);
    else Serial.write(' ');
    Serial.print("  ");
    pbA++;
  }
  Serial.println();
}

void print_buffer_header(uint8_t index) {
  BufferInfoClass *buf = &buffers[index];
  Serial.print("  ");
  Serial.print(buf->cb_buffer, DEC);
  Serial.print(" (");
  for (uint8_t i = 0; i < buf->cb_copy_cnt; i++) {
    if (i != 0) Serial.print(",");
    Serial.print(buf->cb_copy[i], DEC);
  }
  Serial.print(")");
}

void CompareBuffers(uint8_t index1, uint8_t index2) {
  if (buffers[index1].cb_buffer == buffers[index2].cb_buffer) {
    if (memcmp(buffers[index1].buffer, buffers[index2].buffer, buffers[index1].cb_buffer) == 0) {
      Serial.println(" ** Match **");
      return;
    } else {
      Serial.println(" ** different **");
    }
  } else {
    Serial.println(" ** counts different **");
  }
  memory_dump(buffers[index1].buffer, buffers[index1].cb_buffer);
  memory_dump(buffers[index2].buffer, buffers[index2].cb_buffer);
}

void loop() {
  CopyFromTo(Serial, Serial1, 0);
  CopyFromTo(Serial1, Serial, 1);
#ifdef USE_SERIAL2
  CopyFromTo(Serial2, Serial2, 2);
#endif
#ifdef USE_SERIAL3
  CopyFromTo(Serial3, Serial3, 3);
#endif
#ifdef USE_SERIAL4
  CopyFromTo(Serial4, Serial4, 4);
#endif

  // now see if we should compare the data yet or not
  if (buffers[0].cb_buffer && ((millis() - millis_last_input) > 100)) {
    Serial.println("Check buffers: ");

    print_buffer_header(0);
    Serial.println();

    for (uint8_t i = 1; i < 5; i++) {
      print_buffer_header(i);
      CompareBuffers(0, i);
    }
    for (uint8_t i = 0; i < 5; i++) buffers[i].clear();
  }

  digitalWrite(LED_BUILTIN, HIGH);
  delayMicroseconds(100);  // give time form things to propagate
  digitalWrite(LED_BUILTIN, LOW);
}

@KurtE
Some Serial object fixes...
0aa1c92 
added availableForWrite - overwrite Print virtual - get it from ring buffer
fix peek and Read, that if 0 bytes read from ring buffer return -1

begin method appeared to have initial garbage in it.  so have it call ring_buf_reset on the rx ring buffer
@KurtE
Copy link
Author

KurtE commented Nov 29, 2024

Test setup
image

KurtE added 3 commits November 29, 2024 15:48
@KurtE
Update arduino_giga_r1_m7.overlay
a64ced3 
Added the other serial ports
@KurtE
SerialX.flush() - now wait until TC Complete
5c4e10e 
SerialX.flush() - now waits until the TX completes...
Looks at the TC flag of the uart to know when it has completed
the transfer.

Moved the flush() function to .cpp file as it now uses the device header
file which is only included in the .cpp file
@KurtE
zephyrSerial.h - reduce compiler warnings
a565a0a
@facchinm
Copy link
Member

facchinm commented Dec 9, 2024

Hi @KurtE ,
sorry for the long delay before tackling this PR (and in general the forum activity) but I was waiting for the official launch 🙂

All the changes look sensible, I'm merging it right now!

(PS: we'll be much more responsive now in the various channels 😉 )

@facchinm facchinm merged commit cfe5606 into arduino:arduino Dec 9, 2024
1 of 3 checks passed
@KurtE KurtE deleted the giga_Serial_fixex branch December 9, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KurtE @facchinm