HardwareSerial::_tx_udr_empty_irq()

概要

HardwareSerial::_tx_udr_empty_irq()は、Arduinoのシリアル通信送信バッファからAtmega328Pのデータ送信レジスタにデータをコピーします。

この関数は、HardwareSerial::flush()HardwareSerial::write()USART_UDRE_vect(割り込みベクタ)から呼び出されます。

ソースコード

HardwareSerial::_tx_udr_empty_irq()は、hardware/arduino/avr/cores/arduino/HardwareSerial.cppに定義されています。以下に全ソースコードを示します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
void HardwareSerial::_tx_udr_empty_irq(void)
{
  // If interrupts are enabled, there must be more data in the output
  // buffer. Send the next byte
  unsigned char c = _tx_buffer[_tx_buffer_tail];
  _tx_buffer_tail = (_tx_buffer_tail + 1) % SERIAL_TX_BUFFER_SIZE;

  *_udr = c;

  // clear the TXC bit -- "can be cleared by writing a one to its bit
  // location". This makes sure flush() won't return until the bytes
  // actually got written. Other r/w bits are preserved, and zeroes
  // written to the rest.

  *_ucsra = ((*_ucsra) & ((1 << U2X0) | (1 << MPCM0))) | (1 << TXC0);

  if (_tx_buffer_head == _tx_buffer_tail) {
    // Buffer empty, so disable interrupts
    cbi(*_ucsrb, UDRIE0);
  }
}

入力はありません。戻り値もありません。

1
2
void HardwareSerial::_tx_udr_empty_irq(void)
{

_tx_buffer(送信用のバッファ)から、一番古いデータ(_tx_buffer_tail番目のデータ)を取り出し、cに代入します。

3
4
5
6
7
8
  // If interrupts are enabled, there must be more data in the output
  // buffer. Send the next byte
  unsigned char c = _tx_buffer[_tx_buffer_tail];
  _tx_buffer_tail = (_tx_buffer_tail + 1) % SERIAL_TX_BUFFER_SIZE;
 
  *_udr = c;

バッファから一文字取り出したので、_tx_buffer_tailに1を足し、一つ進めます。_tx_bufferはリングバッファなので、1を足した後の_tx_buffer_tailがSERIAL_TX_BUFFER_SIZEを超えたときのために、SERIAL_TX_BUFFER_SIZEで割った余りで補正します。

その後、_udr(UDRn)レジスタにcを代入します。_udrはシリアル通信の送信用のバッファのアドレスが代入されています。

10
11
12
13
14
15
  // clear the TXC bit -- "can be cleared by writing a one to its bit
  // location". This makes sure flush() won't return until the bytes
  // actually got written. Other r/w bits are preserved, and zeroes
  // written to the rest.
 
  *_ucsra = ((*_ucsra) & ((1 << U2X0) | (1 << MPCM0))) | (1 << TXC0);

_ucsra(UCSR0Aレジスタ)のTXC0ビットを1にすることで、TXC0ビットがクリアされます(0になります)。これにより、未送信データありの状態にします。

少しわかりづらいですが、U2X0ビットとMPCM0ビットは保存したうえで、TXC0を1に設定しています。

15
16
17
18
19
  if (_tx_buffer_head == _tx_buffer_tail) {
    // Buffer empty, so disable interrupts
    cbi(*_ucsrb, UDRIE0);
  }
}

_tx_buffer_headとtx_buffer_tailが同じ場合(Arduinoの送信バッファが空になった場合)は、cbi()を使い、_ucsrb(UCSR0Bレジスタ)ののUDRIE0ビットをクリアし、割り込みを禁止します。

バージョン

Arduino AVR Boards 1.8.6

ライセンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/*
  Copyright (c) 2016 garretlab.
  Added source code explanation by garretlab.
*/

/*
  HardwareSerial.cpp - Hardware serial library for Wiring
  Copyright (c) 2006 Nicholas Zambetti.  All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

  Modified 23 November 2006 by David A. Mellis
  Modified 28 September 2010 by Mark Sproul
  Modified 14 August 2012 by Alarus
  Modified 3 December 2013 by Matthijs Kooijman
*/

最終更新日

April 28, 2019

inserted by FC2 system