HAL.I2C

Entities

Simple Types

Interface Types

Access Types

Subtypes

Subprograms

Description

---------------------------------------------------------------------------- -- Copyright (C) 2015-2016, AdaCore -- -- Redistribution and use in source and binary forms, with or without -- modification, are permitted provided that the following conditions are -- met: -- 1. Redistributions of source code must retain the above copyright -- notice, this list of conditions and the following disclaimer. -- 2. Redistributions in binary form must reproduce the above copyright -- notice, this list of conditions and the following disclaimer in -- the documentation and/or other materials provided with the -- distribution. -- 3. Neither the name of the copyright holder nor the names of its -- contributors may be used to endorse or promote products derived -- from this software without specific prior written permission. -- -- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -- HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -- -- ----------------------------------------------------------------------------

Any_I2C_Port

type Any_I2C_Port is access all I2C_Port'Class;

I2C_Address

subtype I2C_Address is UInt10;

I2C_Data

subtype I2C_Data is UInt8_Array;

I2C_Memory_Address_Size

type I2C_Memory_Address_Size is
  (Memory_Size_8b,
   Memory_Size_16b);
Enumeration Literal
Memory_Size_8b
Memory_Size_16b

I2C_Port

type I2C_Port is limited interface;

I2C_Status

type I2C_Status is
  (Ok,
   Err_Error,
   Err_Timeout,
   Busy);
Enumeration Literal
Ok
Err_Error
Err_Timeout
Busy

Master_Receive

procedure Master_Receive
  (This    : in out I2C_Port;
   Addr    : I2C_Address;
   Data    : out I2C_Data;
   Status  : out I2C_Status;
   Timeout : Natural := 1000)
Parameters
This
Addr
Data
Status
Timeout

Master_Transmit

procedure Master_Transmit
  (This    : in out I2C_Port;
   Addr    : I2C_Address;
   Data    : I2C_Data;
   Status  : out I2C_Status;
   Timeout : Natural := 1000)
Parameters
This
Addr
Data
Status
Timeout

Mem_Read

procedure Mem_Read
  (This          : in out I2C_Port;
   Addr          : I2C_Address;
   Mem_Addr      : UInt16;
   Mem_Addr_Size : I2C_Memory_Address_Size;
   Data          : out I2C_Data;
   Status        : out I2C_Status;
   Timeout       : Natural := 1000)
Parameters
This
Addr
Mem_Addr
Mem_Addr_Size
Data
Status
Timeout

Mem_Write

procedure Mem_Write
  (This          : in out I2C_Port;
   Addr          : I2C_Address;
   Mem_Addr      : UInt16;
   Mem_Addr_Size : I2C_Memory_Address_Size;
   Data          : I2C_Data;
   Status        : out I2C_Status;
   Timeout       : Natural := 1000)
Parameters
This
Addr
Mem_Addr
Mem_Addr_Size
Data
Status
Timeout