sii_page.h

Go to the documentation of this file.

/*****************************************************************************
 *
 *  Copyright (C) 2026  Florian Pose, Ingenieurgemeinschaft IgH
 *
 *  This file is part of the IgH EtherCAT Master.
 *
 *  The IgH EtherCAT Master is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License version 2, as
 *  published by the Free Software Foundation.
 *
 *  The IgH EtherCAT Master 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 General
 *  Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with the IgH EtherCAT Master; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 ****************************************************************************/

/****************************************************************************/

#ifndef __EC_SII_PAGE_H__
#define __EC_SII_PAGE_H__

#include <linux/types.h>
#include <linux/list.h>

/****************************************************************************/

typedef enum {
    EC_SII_PAGE_UNKNOWN, 
    EC_SII_PAGE_FETCHED, 
    EC_SII_PAGE_CACHED, 
} ec_sii_page_origin_t;

/****************************************************************************/

typedef struct ec_sii_page
{
    struct list_head list; 
    // Identification for caching
    uint32_t vendor_id; 
    uint32_t product_code; 
    uint32_t revision_number; 
    uint32_t serial_number; 
    uint16_t alias; 
    ec_sii_page_origin_t origin; 
    uint16_t *words; 
    size_t word_count; 
} ec_sii_page_t;

/****************************************************************************/

// slave construction/destruction
void ec_sii_page_init(ec_sii_page_t *);
void ec_sii_page_clear(ec_sii_page_t *);

int ec_sii_page_alloc(ec_sii_page_t *, size_t);
int ec_sii_page_copy(ec_sii_page_t *, const ec_sii_page_t *);

/****************************************************************************/

#endif