utl/doc/latex/i2c_8h.tex

\hypertarget{i2c_8h}{}\section{include/utl/com/i2c.h File Reference}
\label{i2c_8h}\index{include/utl/com/i2c.\+h@{include/utl/com/i2c.\+h}}


An Abstract base class interface for the i2c bus.  


{\ttfamily \#include $<$utl/core/impl.\+h$>$}\newline
{\ttfamily \#include $<$utl/core/crtp.\+h$>$}\newline
{\ttfamily \#include $<$utl/meta/meta.\+h$>$}\newline
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{classutl_1_1i2c__i}{utl\+::i2c\+\_\+i$<$ impl\+\_\+t $>$}}
\begin{DoxyCompactList}\small\item\em Abstract base class for i2c bus. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{classutl_1_1i2c__i_3_01virtual__tag_01_4}{utl\+::i2c\+\_\+i$<$ virtual\+\_\+tag $>$}}
\begin{DoxyCompactList}\small\item\em A virtual base class specialization. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structutl_1_1i2c__i__details_1_1is__i2c__}{utl\+::i2c\+\_\+i\+\_\+details\+::is\+\_\+i2c\+\_\+$<$ \+\_\+\+Tp, typename $>$}}
\begin{DoxyCompactList}\small\item\em Primary template to catch any non I2C interface types. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structutl_1_1i2c__i__details_1_1is__i2c___3_01___tp_00_01meta_1_1void__t_3_01typename_01___tp_1_1_sequence_00_01void_01_4_01_4}{utl\+::i2c\+\_\+i\+\_\+details\+::is\+\_\+i2c\+\_\+$<$ \+\_\+\+Tp, meta\+::void\+\_\+t$<$ typename \+\_\+\+Tp\+::\+Sequence, void $>$ $>$}}
\begin{DoxyCompactList}\small\item\em template to catch a proper I2C interface type \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Namespaces}
\begin{DoxyCompactItemize}
\item 
 \mbox{\hyperlink{namespaceutl}{utl}}
\begin{DoxyCompactList}\small\item\em S\+TL\textquotesingle{}s core language concepts. \end{DoxyCompactList}\item 
 \mbox{\hyperlink{namespaceutl_1_1i2c__i__details}{utl\+::i2c\+\_\+i\+\_\+details}}
\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
{\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1i2c__i__details_a81c12a06fe9cf6f643718f9175da8769}{utl\+::i2c\+\_\+i\+\_\+details\+::try\+\_\+cclk\+\_\+t}} = decltype(declval$<$ const \+\_\+\+Tp $>$().clock())
\item 
{\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1i2c__i__details_adaf6b9dbc57caeda1a6a85bd17ac6317}{utl\+::i2c\+\_\+i\+\_\+details\+::try\+\_\+clk\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().clock(declval$<$ uint32\+\_\+t $>$()))
\item 
{\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1i2c__i__details_a173335d0a45cba1b159bf33bcefb3a46}{utl\+::i2c\+\_\+i\+\_\+details\+::try\+\_\+start\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().start())
\item 
{\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1i2c__i__details_a25cbce342478441f05d3a101fcafc02c}{utl\+::i2c\+\_\+i\+\_\+details\+::try\+\_\+stop\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().stop())
\item 
{\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1i2c__i__details_a10de1b351bd683c5435e2db3d682819c}{utl\+::i2c\+\_\+i\+\_\+details\+::try\+\_\+rx\+\_\+data\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().rx\+\_\+data(declval$<$ bool $>$(), declval$<$ typename \+\_\+\+Tp\+::\+Sequence $>$()))
\item 
{\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1i2c__i__details_ad8d87a56b12244ba8060f8d27207083f}{utl\+::i2c\+\_\+i\+\_\+details\+::try\+\_\+tx\+\_\+data\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().tx\+\_\+data(declval$<$ byte\+\_\+t $>$(), declval$<$ typename \+\_\+\+Tp\+::\+Sequence $>$()))
\end{DoxyCompactItemize}


\subsection{Detailed Description}
An Abstract base class interface for the i2c bus. 

Copyright (C) 2018 Christos Choutouridis

This program is free software\+: you can redistribute it and/or modify it under the terms of the G\+NU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but W\+I\+T\+H\+O\+UT A\+NY W\+A\+R\+R\+A\+N\+TY; without even the implied warranty of M\+E\+R\+C\+H\+A\+N\+T\+A\+B\+I\+L\+I\+TY or F\+I\+T\+N\+E\+SS F\+OR A P\+A\+R\+T\+I\+C\+U\+L\+AR P\+U\+R\+P\+O\+SE. See the G\+NU Lesser General Public License for more details.

You should have received a copy of the G\+NU Lesser General Public License along with this program. If not, see \href{http://www.gnu.org/licenses/}{\tt http\+://www.\+gnu.\+org/licenses/}.