uapi/linux/cycx_cfm.h

0001 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
0002 /*
0003 * cycx_cfm.h    Cyclom 2X WAN Link Driver.
0004 *       Definitions for the Cyclom 2X Firmware Module (CFM).
0005 *
0006 * Author:   Arnaldo Carvalho de Melo <acme@conectiva.com.br>
0007 *
0008 * Copyright:    (c) 1998-2003 Arnaldo Carvalho de Melo
0009 *
0010 * Based on sdlasfm.h by Gene Kozin <74604.152@compuserve.com>
0011 *
0012 *       This program is free software; you can redistribute it and/or
0013 *       modify it under the terms of the GNU General Public License
0014 *       as published by the Free Software Foundation; either version
0015 *       2 of the License, or (at your option) any later version.
0016 * ============================================================================
0017 * 1998/08/08    acme        Initial version.
0018 */
0019 #ifndef _CYCX_CFM_H
0020 #define _CYCX_CFM_H
0021
0022 /* Defines */
0023
0024 #define CFM_VERSION 2
0025 #define CFM_SIGNATURE   "CFM - Cyclades CYCX Firmware Module"
0026
0027 /* min/max */
0028 #define CFM_IMAGE_SIZE  0x20000 /* max size of CYCX code image file */
0029 #define CFM_DESCR_LEN   256 /* max length of description string */
0030 #define CFM_MAX_CYCX    1   /* max number of compatible adapters */
0031 #define CFM_LOAD_BUFSZ  0x400   /* buffer size for reset code (buffer_load) */
0032
0033 /* Firmware Commands */
0034 #define GEN_POWER_ON    0x1280
0035
0036 #define GEN_SET_SEG 0x1401  /* boot segment setting. */
0037 #define GEN_BOOT_DAT    0x1402  /* boot data. */
0038 #define GEN_START   0x1403  /* board start. */
0039 #define GEN_DEFPAR  0x1404  /* buffer length for boot. */
0040
0041 /* Adapter Types */
0042 #define CYCX_2X     2
0043 /* for now only the 2X is supported, no plans to support 8X or 16X */
0044 #define CYCX_8X     8
0045 #define CYCX_16X    16
0046
0047 #define CFID_X25_2X 5200
0048
0049 /**
0050  *  struct cycx_fw_info - firmware module information.
0051  *  @codeid - firmware ID
0052  *  @version - firmware version number
0053  *  @adapter - compatible adapter types
0054  *  @memsize - minimum memory size
0055  *  @reserved - reserved
0056  *  @startoffs - entry point offset
0057  *  @winoffs - dual-port memory window offset
0058  *  @codeoffs - code load offset
0059  *  @codesize - code size
0060  *  @dataoffs - configuration data load offset
0061  *  @datasize - configuration data size
0062  */
0063 struct cycx_fw_info {
0064     unsigned short  codeid;
0065     unsigned short  version;
0066     unsigned short  adapter[CFM_MAX_CYCX];
0067     unsigned long   memsize;
0068     unsigned short  reserved[2];
0069     unsigned short  startoffs;
0070     unsigned short  winoffs;
0071     unsigned short  codeoffs;
0072     unsigned long   codesize;
0073     unsigned short  dataoffs;
0074     unsigned long   datasize;
0075 };
0076
0077 /**
0078  *  struct cycx_firmware - CYCX firmware file structure
0079  *  @signature - CFM file signature
0080  *  @version - file format version
0081  *  @checksum - info + image
0082  *  @reserved - reserved
0083  *  @descr - description string
0084  *  @info - firmware module info
0085  *  @image - code image (variable size)
0086  */
0087 struct cycx_firmware {
0088     char            signature[80];
0089     unsigned short      version;
0090     unsigned short      checksum;
0091     unsigned short      reserved[6];
0092     char            descr[CFM_DESCR_LEN];
0093     struct cycx_fw_info info;
0094     unsigned char       image[];
0095 };
0096
0097 struct cycx_fw_header {
0098     unsigned long  reset_size;
0099     unsigned long  data_size;
0100     unsigned long  code_size;
0101 };
0102 #endif  /* _CYCX_CFM_H */