system/uapp/i2c/i2c.c

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <errno.h>
#include <fcntl.h>
#include <zircon/syscalls.h>
#include <zircon/types.h>
#include <zircon/device/i2c.h>
#include <lib/fdio/util.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

const char* prog_name;

void print_usage(void) {
    printf("Usage:\n");
    printf("\n");
    printf("%s DEVICE COMMAND [command arguments]\n", prog_name);
    printf("DEVICE is either the i2c bus or i2c slave COMMAND applies to.\n");
    printf("COMMAND is one of the following commands, optionally followed \n");
    printf("arguments which are specific to each command.\n");
    printf("\n");
    printf("add-slave ADDRESS: Add a slave device to the target bus.\n");
    printf("ADDRESS is the 7 bit chip address of the slave in hex.\n");
    printf("\n");
    printf("remove-slave ADDRESS: Remove a slave from the target bus.\n");
    printf("ADDRESS is the 7 bit chip address of the slave in hex.\n");
    printf("\n");
    printf("set-frequency FREQUENCY: Set the frequency of the target bus.\n");
    printf("FREQUENCY is the frequency to set the bus to in decimal Hz.\n");
    printf("\n");
    printf("read LENGTH: Read data from the target slave device.\n");
    printf("LENGTH is the number of bytes to read in decimal.\n");
    printf("\n");
    printf("write [data]: Write data to the target slave device.\n");
    printf("data is a sequence of hex values which each represent one byte\n");
    printf("of data to write to the target device.\n");
    printf("\n");
    printf("transfer [segments]: Perform a tranfer to/from the i2c slave.\n");
    printf("segments is a series of segment descriptions which are a\n");
    printf("direction, a length, and then (for writes) a series of bytes\n");
    printf("in hexidecimal.\n");
    printf("\n");
    printf("The direction is specified as either \"w\" for writes, or\n");
    printf("\"r\" for reads.\n");
    printf("\n");
    printf("For example, to perform a write of one byte and then a read\n");
    printf("of one byte without giving up the bus:\n");
    printf("%s [dev] transfer w 1 00 r 1\n", prog_name);
}

int cmd_add_slave(int fd, int argc, const char** argv) {
    if (argc < 1) {
        print_usage();
        return 1;
    }

    errno = 0;
    long int address = strtol(argv[0], NULL, 16);
    if (errno) {
        print_usage();
        return errno;
    }

    i2c_ioctl_add_slave_args_t add_slave_args = {
        .chip_address_width = I2C_7BIT_ADDRESS,
        .chip_address = address,
    };

    ssize_t ret = ioctl_i2c_bus_add_slave(fd, &add_slave_args);
    if (ret < 0) {
        printf("Error when adding I2C slave. (%zd)\n", ret);
        return 1;
    }

    return 0;
}

int cmd_remove_slave(int fd, int argc, const char** argv) {
    if (argc < 1) {
        print_usage();
        return 1;
    }

    errno = 0;
    long int address = strtol(argv[0], NULL, 16);
    if (errno) {
        print_usage();
        return errno;
    }

    i2c_ioctl_remove_slave_args_t remove_slave_args = {
        .chip_address_width = I2C_7BIT_ADDRESS,
        .chip_address = address,
    };

    ssize_t ret = ioctl_i2c_bus_remove_slave(fd, &remove_slave_args);
    if (ret < 0) {
        printf("Error when removing I2C slave. (%zd)\n", ret);
        return 1;
    }

    return 0;
}

int cmd_set_bus_frequency(int fd, int argc, const char** argv) {
    if (argc < 1) {
        print_usage();
        return 1;
    }

    errno = 0;
    long int frequency = strtol(argv[0], NULL, 10);
    if (errno) {
        print_usage();
        return errno;
    }

    i2c_ioctl_set_bus_frequency_args_t set_bus_frequency_args = {
        .frequency = frequency,
    };

    ssize_t ret = ioctl_i2c_bus_set_frequency(fd, &set_bus_frequency_args);
    if (ret < 0) {
        printf("Error when setting bus frequency. (%zd)\n", ret);
        return 1;
    }

    return 0;
}

int cmd_read(int fd, int argc, const char** argv) {
    if (argc < 1) {
        print_usage();
        return 1;
    }

    errno = 0;
    long int length = strtol(argv[0], NULL, 10);
    if (errno) {
        print_usage();
        return errno;
    }

    uint8_t* buf = malloc(length);
    if (!buf) {
        printf("Failed to allocate buffer.\n");
        return 1;
    }

    int ret = read(fd, buf, length);
    if (ret < 0) {
        printf("Error reading from slave. (%d)\n", ret);
        goto cmd_read_finish;
    }

    for (int i = 0; i < length; i++) {
        printf(" %02x", buf[i]);
        if (i % 32 == 31) printf("\n");
    }
    printf("\n");

cmd_read_finish:
    free(buf);
    return ret;
}

int cmd_write(int fd, int argc, const char** argv) {
    if (argc < 1) {
        print_usage();
        return 1;
    }

    uint8_t* buf = malloc(argc);
    if (!buf) {
        printf("Failed to allocate buffer.\n");
        return 1;
    }

    int ret = 0;

    errno = 0;
    for (int i = 0; i < argc; i++) {
        buf[i] = strtol(argv[i], NULL, 16);
        if (errno) {
            ret = errno;
            print_usage();
            goto cmd_write_finish;
        }
    }

    ret = write(fd, buf, argc);
    if (ret < 0)
        printf("Error writing to slave. (%d)\n", ret);

cmd_write_finish:
    free(buf);
    return ret;
}

int cmd_transfer(int fd, int argc, const char** argv) {
    const size_t base_size = sizeof(i2c_slave_ioctl_segment_t);
    int ret = ZX_OK;

    // Figure out how big our buffers need to be.
    // Start the counters with enough space for the I2C_SEGMENT_TYPE_END
    // segment.
    size_t in_len = base_size;
    size_t out_len = 0;
    int segments = 1;
    int count = argc;
    const char** arg = argv;
    errno = 0;
    while (count) {
        if (count < 2) {
            print_usage();
            goto cmd_transfer_finish_2;
        }

        in_len += base_size;

        int read;
        if (!strcmp(arg[0], "r")) {
            read = 1;
        } else if (!strcmp(arg[0], "w")) {
            read = 0;
        } else {
            print_usage();
            goto cmd_transfer_finish_2;
        }
        segments++;

        long int length = strtol(arg[1], NULL, 10);
        if (errno) {
            print_usage();
            return errno;
        }
        arg += 2;
        count -= 2;
        if (read) {
            out_len += length;
        } else {
            in_len += length;
            if (length > count) {
                print_usage();
                goto cmd_transfer_finish_2;
            }
            arg += length;
            count -= length;
        }
    }

    // Allocate the input and output buffers.
    void* in_buf = malloc(in_len);
    void* out_buf = malloc(out_len);
    if (!in_buf || !out_buf) {
        ret = 1;
        goto cmd_transfer_finish_1;
    }
    uint8_t* data_addr = (uint8_t*)in_buf + segments * base_size;
    uint8_t* data_buf = data_addr;

    // Fill the "input" buffer which is sent to the ioctl.
    uintptr_t in_addr = (uintptr_t)in_buf;
    int i = 0;
    i2c_slave_ioctl_segment_t* ioctl_segment = (i2c_slave_ioctl_segment_t*)in_addr;
    while (i < argc) {
        if (!strcmp(argv[i++], "r")) {
            ioctl_segment->type = I2C_SEGMENT_TYPE_READ;
            ioctl_segment->len = strtol(argv[i++], NULL, 10);
            if (errno) {
                print_usage();
                return errno;
            }
        } else {
            ioctl_segment->type = I2C_SEGMENT_TYPE_WRITE;
            ioctl_segment->len = strtol(argv[i++], NULL, 10);
            if (errno) {
                print_usage();
                return errno;
            }

            for (int seg = 0; seg < ioctl_segment->len; seg++) {
                *data_buf++ = strtol(argv[i++], NULL, 16);
                if (errno) {
                    print_usage();
                    return errno;
                }
            }
        }
        ioctl_segment++;
    }
    ioctl_segment->type = I2C_SEGMENT_TYPE_END;
    ioctl_segment->len = 0;
    ioctl_segment++;
    // We should be at the start of the data section now.
    if ((uint8_t*)ioctl_segment != data_addr) {
        ret = 1;
        goto cmd_transfer_finish_1;
    }

    ret = ioctl_i2c_slave_transfer(fd, in_buf, in_len, out_buf, out_len);
    if (ret < 0)
        goto cmd_transfer_finish_1;

    for (size_t i = 0; i < out_len; i++) {
        printf(" %02x", ((uint8_t*)out_buf)[i]);
        if (i % 32 == 31) printf("\n");
    }
    printf("\n");

    ret = 0;

cmd_transfer_finish_1:
    free(in_buf);
    free(out_buf);
cmd_transfer_finish_2:
    return ret;
}

int main(int argc, const char** argv) {
    if (argc < 1)
        return 1;

    prog_name = argv[0];

    if (argc < 3) {
        print_usage();
        return 1;
    }

    const char* dev = argv[1];
    const char* cmd = argv[2];

    argc -= 3;
    argv += 3;

    int fd = open(dev, O_RDWR);
    if (fd < 0) {
        printf("Error opening I2C device.\n");
        return 1;
    }

    if (!strcmp("add-slave", cmd)) {
        return cmd_add_slave(fd, argc, argv);
    } else if (!strcmp("remove-slave", cmd)) {
        return cmd_remove_slave(fd, argc, argv);
    } else if (!strcmp("set-frequency", cmd)) {
        return cmd_set_bus_frequency(fd, argc, argv);
    } else if (!strcmp("read", cmd)) {
        return cmd_read(fd, argc, argv);
    } else if (!strcmp("write", cmd)) {
        return cmd_write(fd, argc, argv);
    } else if (!strcmp("transfer", cmd)) {
        return cmd_transfer(fd, argc, argv);
    } else {
        printf("Unrecognized command %s.\n", cmd);
        print_usage();
        return 1;
    }

    printf("We should never get here!.\n");
    return 1;
}