Real Time Clock (RTC) Drivers for Linux

https://www.kernel.org/doc/html/latest/admin-guide/rtc.html

# Real Time Clock (RTC) Drivers for Linux

> When Linux developers talk about a “Real Time Clock”, they usually mean something that tracks wall clock time and is battery backed so that it works even with system power off. Such clocks will normally not track the local time zone or daylight savings time – unless they dual boot with MS-Windows – but will instead be set to Coordinated Universal Time (UTC, formerly “Greenwich Mean Time”).

Linux 開発者が"Real Time Clock"と言った場合、通常それはwall clock timeを追従し、system power offであっても動き続けるようにバッテリーでバックアップされているものを示します。このようなclockは通常、ローカルタイムゾーンや夏時間を追従しません（MS-Windowsとのdual bootをしていなければ）。その代わりに、協定世界時(UTC, 従来の「グリニッジ標準時）に設定されます。

> The newest non-PC hardware tends to just count seconds, like the time(2) system call reports, but RTCs also very commonly represent time using the Gregorian calendar and 24 hour time, as reported by gmtime(3).

最新のnon-PCハードウェアでは、time(2) system callでの報告のように、秒単位でカウントする傾向があります。ただし、RTCはまた、gmtime(3)での報告のように、グレゴリオ暦と24時間の時間を使用して時間を表現することも非常に一般的です。
> Linux has two largely-compatible userspace RTC API families you may need to know about:

Linuxには、知っておくべき、２つの大きな互換性のあるユーザー空間RTC API familiyがあります。

> ・/dev/rtc … is the RTC provided by PC compatible systems, so it’s not very portable to non-x86 systems.
・/dev/rtc0, /dev/rtc1 … are part of a framework that’s supported by a wide variety of RTC chips on all systems.

・/dev/rtc … PC互換システムで提供されるRTC。非-x86 systemでは移植性がない。
・/dev/rtc0, /dev/rtc1 … 全てのシステムにおいて幅広いRTC chipでサポートされているフレームワークの一部。

> Programmers need to understand that the PC/AT functionality is not always available, and some systems can do much more. That is, the RTCs use the same API to make requests in both RTC frameworks (using different filenames of course), but the hardware may not offer the same functionality. For example, not every RTC is hooked up to an IRQ, so they can’t all issue alarms; and where standard PC RTCs can only issue an alarm up to 24 hours in the future, other hardware may be able to schedule one any time in the upcoming century.

プログラマは、PC/AT機能性が常に有効ではないことを理解しなければなりません。そして、システムによってはそれ以上のことができることもあります。これはつまり、RTCは２つのRTC frameworkからの要求に対して同じAPIを使います。しかし、ハードウェアは同じ機能性を提供しません。例えば、全てのRTCはIRQでフックできるわけではなく、alarm問題を取り扱えません。また、標準的なPCのRTCは将来の24時間に対するalarmをセットできますが、他のハードウェアでは更に将来にわたってのスケジュールを組むこともできます。

# Old PC/AT-Compatible driver: /dev/rtc

> All PCs (even Alpha machines) have a Real Time Clock built into them. Usually they are built into the chipset of the computer, but some may actually have a Motorola MC146818 (or clone) on the board. This is the clock that keeps the date and time while your computer is turned off.

全てのPC(Alpha machineも含む)には、Real Time Clockが組み込まれています。通常これらは、コンピュータのチップセットに組み込まれているか、ボード上にMotorola MC146818(あるいはそのクローン）を有しているでしょう。これは、コンピュータの電源が切れている間の、日付と時刻を保持するclockです。

> ACPI has standardized that MC146818 functionality, and extended it in a few ways (enabling longer alarm periods, and wake-from-hibernate). That functionality is NOT exposed in the old driver.

ACPIは、MC146818の機能性の標準化し、いくつかの拡張もしました（alarm periodの延長や、wake-from-hibernate)。この機能性は、過去のドライバで提供されていないものです。

> However it can also be used to generate signals from a slow 2Hz to a relatively fast 8192Hz, in increments of powers of two. These signals are reported by interrupt number 8. (Oh! So that is what IRQ 8 is for…) It can also function as a 24hr alarm, raising IRQ 8 when the alarm goes off. The alarm can also be programmed to only check any subset of the three programmable values, meaning that it could be set to ring on the 30th second of the 30th minute of every hour, for example. The clock can also be set to generate an interrupt upon every clock update, thus generating a 1Hz signal.

ただし、これはsignalの生成に使うことができます、最も遅いケースでは2Hz、比較的早い8192Hzまで、2の階乗の増分で。このシグナルは、割り込み番号8で通知されます(Oh! それはIRQ 8の役割です）。これは、alarmが到達するとIRQ 8信号が下がることで、24時間alarmとして機能をさせることができます。Alarmはまた、３つの変更可能な変数のサブセットだけをチェックすることができます、すなわち、例えば、毎時の30分の30秒に鳴るようにセットすることもできます。clockはまた、クロックが更新されるたびに割り込みを生成することもでき、この場合1Hzの信号が生成されます。

> The interrupts are reported via /dev/rtc (major 10, minor 135, read only character device) in the form of an unsigned long. The low byte contains the type of interrupt (update-done, alarm-rang, or periodic) that was raised, and the remaining bytes contain the number of interrupts since the last read. Status information is reported through the pseudo-file /proc/driver/rtc if the /proc filesystem was enabled. The driver has built in locking so that only one process is allowed to have the /dev/rtc interface open at a time.

割り込みは、/dev/rtc(major 10, minor 135, read only character device)を介して、unsigned longの形で通知されます。low byteには、割り込みの種別（update-done, alarm-rang, or periodic)が発生したことが含まれ、残りのバイトには最後に読み込んでからの割り込み回数が含まれます。/proc filesystemが有効な場合、Status informationが、疑似ファイル /proc/driver/rtcを介して通知されます。ドライバーにはロックが組み込まれているため、一度の１つのプロセスだけが/dev/rtcを開くことが出います。

> A user process can monitor these interrupts by doing a read(2) or a select(2) on /dev/rtc – either will block/stop the user process until the next interrupt is received. This is useful for things like reasonably high frequency data acquisition where one doesn’t want to burn up 100% CPU by polling gettimeofday etc. etc.

ユーザープロセスは、これらの割り込みを、/dev/rtcに対するread(2)やselect(2)で監視することができます。これらは次の割り込みがくるまでuser processはblock/stopするでしょう。これは、gettimeofdayなど等をポーリングしてCPU使用率100%で回り続けたくない場合に、高い頻度でデータ取得するのに有益です。

> At high frequencies, or under high loads, the user process should check the number of interrupts received since the last read to determine if there has been any interrupt “pileup” so to speak. Just for reference, a typical 486-33 running a tight read loop on /dev/rtc will start to suffer occasional interrupt pileup (i.e. > 1 IRQ event since last read) for frequencies above 1024Hz. So you really should check the high bytes of the value you read, especially at frequencies above that of the normal timer interrupt, which is 100Hz.

高頻度、あるいは高い付加において、ユーザープロセスは、最後の読み取り以後に受信した割り込みの数を確認し、いわゆる割り込みの「山」があったかどうかを判断しなければなりません。参考までに、/dev/rtcを厳しく読んでいる、一般的な486-33(訳注：i486 の 33MHz と思われる）では、1024Hzを超える周波数で、割り込みのpileupが時々発生しています（つまり、 1 IRQ イベントが最後の読み込みよりも大きい）。したがって、特に通常のタイマー割り込みが100Hzを越える周波数であれば、読み取った値の上位バイトをチェックする必要があります。

> Programming and/or enabling interrupt frequencies greater than 64Hz is only allowed by root. This is perhaps a bit conservative, but we don’t want an evil user generating lots of IRQs on a slow 386sx-16, where it might have a negative impact on performance. This 64Hz limit can be changed by writing a different value to /proc/sys/dev/rtc/max-user-freq. Note that the interrupt handler is only a few lines of code to minimize any possibility of this effect.

64Hzを越える、プログラミング and/or 割り込みの有効化は、rootだけが許可されます。これは、少し保守的かもしれません。しかし、遅い386sx-16(訳注：i386sx-16MHz)で、悪意のあるユーザーが大量のIRQを発生させることは、パフォーマンスに悪影響があります。この64Hzの制限は、/proc/sys/dev/rtc/max-user-freqを書き換える事で変更できます。割り込みハンドラは、この影響を最小に抑えるための数行のコードでしかないことを注意してください。

> Also, if the kernel time is synchronized with an external source, the kernel will write the time back to the CMOS clock every 11 minutes. In the process of doing this, the kernel briefly turns off RTC periodic interrupts, so be aware of this if you are doing serious work. If you don’t synchronize the kernel time with an external source (via ntp or whatever) then the kernel will keep its hands off the RTC, allowing you exclusive access to the device for your applications.

更に、kernel timeが外部ソースによって同期を取られる場合、kernelはCOMS clockを毎11分毎に書き戻します。この処理の過程で、カーネルはRTCのperiodic interruptsを無効化します。そのため、seriousな作業をしている場合は気を付けてください。もし、外部ソースでのkernel timeの補正を必要としない場合（例えば、ntpやその他）には、kernelは、RTCから手を離し、アプリケーションへの排他的アクセスを許可します。

> The alarm and/or interrupt frequency are programmed into the RTC via various ioctl(2) calls as listed in ./include/linux/rtc.h . Rather than write 50 pages describing the ioctl() and so on, it is perhaps more useful to include a small test program that demonstrates how to use them, and demonstrates the features of the driver. This is probably a lot more useful to people interested in writing applications that will be using this driver. See the code at the end of this document.

RTCに対するalarmや割り込み頻度は、include/linux/rtc.hにリスト化された様々なioctl(2)呼び込みによってプログラムできます。50ページにわたってioctl()の説明を記述するよりも、おそらく、デモを通して使い方を説明する小さいテストプログラムと、ドライバの機能をデモンストレーションするほうが有益でしょう。これはおそらく、このドライバーを利用するアプリケーションを書く多くの人々にとって有益です。このドキュメントの最後にあるコードを参照ください。

(The original /dev/rtc driver was written by Paul Gortmaker.)

# New portable “RTC Class” drivers: /dev/rtcN

> Because Linux supports many non-ACPI and non-PC platforms, some of which have more than one RTC style clock, it needed a more portable solution than expecting a single battery-backed MC146818 clone on every system. Accordingly, a new “RTC Class” framework has been defined. It offers three different userspace interfaces:

Linuxが多くのnon-ACPI で、non-PC platformをサポートしており、そしてそれらは１つ以上のRTC style clockを有したため、全てのシステムで、１つのバッテリーバックアップするMC146818 cloneを期待するよりも、移植性のある解決策が必要となりました。そのため、新しい "RTC Class" frameworkが定義されました。これは、３つの異なるユーザーインタフェイスを提供します。

> ・/dev/rtcN … much the same as the older /dev/rtc interface
・/sys/class/rtc/rtcN … sysfs attributes support readonly access to some RTC attributes.
・/proc/driver/rtc … the system clock RTC may expose itself using a procfs interface. If there is no RTC for the system clock, rtc0 is used by default. More information is (currently) shown here than through sysfs.

 ・/dev/rtcN … /dev/rtc interfaceと類似しているもの
・/sys/class/rtc/rtcN … RTC attributeへのreadonly accessを許可する、sysfs attributes
・/proc/driver/rtc … system clock RTCは、自身をprocfs interfaceを介して、公開する必要がある場合があります。もし、system clockのRTCがない場合には、rtc0がデフォルトで使われます。（現在の）sysfsを介した情報よりも多くの情報がここに提示されます。

> The RTC Class framework supports a wide variety of RTCs, ranging from those integrated into embeddable system-on-chip (SOC) processors to discrete chips using I2C, SPI, or some other bus to communicate with the host CPU. There’s even support for PC-style RTCs … including the features exposed on newer PCs through ACPI.

RTC Class frameworkは、非常に幅広いRTCをサポートしています。組込み用のsystem-on-chip(SOC) processorに統合されたものから、I2CやSPIあるいはほかのホストCPUと通信可能なバスに接続されたものまで。ACPIを介して新しいPCで公開されている機能を含めた、PC-style RTCのサポートさえあります。

> The new framework also removes the “one RTC per system” restriction. For example, maybe the low-power battery-backed RTC is a discrete I2C chip, but a high functionality RTC is integrated into the SOC. That system might read the system clock from the discrete RTC, but use the integrated one for all other tasks, because of its greater functionality.

新しいframeworkではまた、"one RTC per system"の制約を無くします。例えば、省電力バックアップバッテリーのRTCは、分離されたI2C chipであり、高機能なRTCはSOCにはに統合されています。このシステムでは、system clockは分離されたRTCから読み出しますが、高度な機能性から、そのほかの処理については、統合されたRTCを使うでしょう。

> Check out tools/testing/selftests/rtc/rtctest.c for an example usage of the ioctl interface.

ioctl interfaceの使い方の例については、tools/testing/selftests/rtc/rtctest.cを確認してください。


---
もともと、Linux Kernelのソースコードの一部なので、GPLv2扱いになる（はずの認識）。

> https://www.kernel.org/doc/html/latest/index.html
> 
> Licensing documentation
> 
> The following describes the license of the Linux kernel source code (GPLv2), how to properly mark the license of individual files in the source tree, as well as links to the full license text.
> 
> https://www.kernel.org/doc/html/latest/process/license-rules.html#kernel-licensing