aboutsummaryrefslogtreecommitdiff
path: root/mkmif.c
blob: 06a2c4b4cf398aae584f1c42d68ba43d7e70abad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 * mkmif.c
 * -------
 * HAL interface to Cryptech Master Key Memory Interface.
 *
 * Copyright (c) 2016, NORDUnet A/S
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - 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.
 *
 * - Neither the name of the NORDUnet 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.
 */

#include <stdlib.h>

#include "hal.h"
#include "hal_internal.h"

typedef union {
    uint8_t byte[4];
    uint32_t word;
} byteword_t;

hal_error_t hal_mkmif_init(hal_core_t *core)
{
    byteword_t cmd;
    hal_error_t err;

    cmd.word = htonl(MKMIF_CTRL_CMD_INIT);

    err = hal_core_alloc(MKMIF_NAME, &core) ||
        hal_io_write(core, MKMIF_ADDR_CTRL, cmd.byte, 4) ||
        hal_io_wait_ready(core);

    hal_core_free(core);
    return err;
}

hal_error_t hal_mkmif_set_clockspeed(hal_core_t *core, const uint32_t divisor)
{
    byteword_t data;
    hal_error_t err;

    data.word = htonl(divisor);

    err = hal_core_alloc(MKMIF_NAME, &core) ||
        hal_io_write(core, MKMIF_ADDR_SCLK_DIV, data.byte, 4);

    hal_core_free(core);
    return err;
}

hal_error_t hal_mkmif_get_clockspeed(hal_core_t *core, uint32_t *divisor)
{
    byteword_t data;
    hal_error_t err;

    err = hal_core_alloc(MKMIF_NAME, &core) ||
        hal_io_read(core, MKMIF_ADDR_SCLK_DIV, data.byte, 4);

    if (err == HAL_OK)
        *divisor = htonl(data.word);

    hal_core_free(core);
    return err;
}

hal_error_t hal_mkmif_write(hal_core_t *core, uint32_t addr, const uint8_t *buf, size_t len)
{
    byteword_t cmd;
    hal_error_t err;

    if (len % 4 != 0)
        return HAL_ERROR_IO_BAD_COUNT;

    cmd.word = htonl(MKMIF_CTRL_CMD_WRITE);

    if ((err = hal_core_alloc(MKMIF_NAME, &core)) == HAL_OK) {
        for (; len > 0; addr += 4, buf += 4, len -= 4) {
            byteword_t write_addr;
            write_addr.word = htonl((uint32_t)addr);
            if ((err = hal_io_write(core, MKMIF_ADDR_EMEM_ADDR, write_addr.byte, 4)) ||
                (err = hal_io_write(core, MKMIF_ADDR_EMEM_DATA, buf, 4)) ||
                (err = hal_io_write(core, MKMIF_ADDR_CTRL, cmd.byte, 4)) ||
                (err = hal_io_wait_ready(core)))
                return err;
        }
    }

    hal_core_free(core);
    return err;
}

hal_error_t hal_mkmif_write_word(hal_core_t *core, uint32_t addr, const uint32_t data)
{
    byteword_t d;

    d.word = htonl(data);

    return hal_mkmif_write(core, addr, d.byte, 4);
}

hal_error_t hal_mkmif_read(hal_core_t *core, uint32_t addr, uint8_t *buf, size_t len)
{
    byteword_t cmd;
    hal_error_t err;

    if (len % 4 != 0)
        return HAL_ERROR_IO_BAD_COUNT;

    cmd.word = htonl(MKMIF_CTRL_CMD_READ);

    if ((err = hal_core_alloc(MKMIF_NAME, &core)) == HAL_OK) {
        for (; len > 0; addr += 4, buf += 4, len -= 4) {
            byteword_t read_addr;
            read_addr.word = htonl((uint32_t)addr);
            if ((err = hal_io_write(core, MKMIF_ADDR_EMEM_ADDR, read_addr.byte, 4)) ||
                (err = hal_io_write(core, MKMIF_ADDR_CTRL, cmd.byte, 4)) ||
                (err = hal_io_wait_valid(core)) ||
                (err = hal_io_read(core, MKMIF_ADDR_EMEM_DATA, buf, 4)))
                goto out;
        }
    }

out:
    hal_core_free(core);
    return err;
}

hal_error_t hal_mkmif_read_word(hal_core_t *core, uint32_t addr, uint32_t *data)
{
    byteword_t d;
    hal_error_t err;

    if ((err = hal_mkmif_read(core, addr, d.byte, 4)) != HAL_OK)
        return err;

    *data = htonl(d.word);

    return HAL_OK;
}
an> data[2], data[3], EOC }; return i2c_write(buf, sizeof(buf)); } static hal_error_t hal_io_send_read_cmd(hal_addr_t offset) { uint8_t buf[5] = { SOC, READ_CMD, (offset >> 8) & 0xff, offset & 0xff, EOC }; return i2c_write(buf, sizeof(buf)); } static hal_error_t hal_io_get_resp(uint8_t *buf, size_t len) { hal_error_t err; int i; for (i = 0; i < len; ++i) { if ((err = i2c_read(&buf[i])) != HAL_OK) return err; if ((i == 0) && (buf[i] != SOR)) /* We've gotten out of sync, and there's probably nothing we can do */ return HAL_ERROR_IO_UNEXPECTED; if (i == 1) { /* response code */ switch (buf[i]) { case READ_OK: len = 9; break; case WRITE_OK: len = 5; break; case RESET_OK: len = 3; break; case ERROR: case UNKNOWN: len = 4; break; default: /* we've gotten out of sync, and there's probably nothing we can do */ return HAL_ERROR_IO_UNEXPECTED; } } } dump("read ", buf, len); return HAL_OK; } static hal_error_t hal_io_compare(uint8_t *buf, const uint8_t *expected, size_t len) { size_t i; /* start at byte 1 because SOR has already been tested */ for (i = 1; i < len; ++i) { if (buf[i] != expected[i]) return HAL_ERROR_IO_UNEXPECTED; } return HAL_OK; } static hal_error_t hal_io_get_write_resp(hal_addr_t offset) { uint8_t buf[5]; uint8_t expected[5] = { SOR, WRITE_OK, (offset >> 8) & 0xff, offset & 0xff, EOR }; hal_error_t err; if ((err = hal_io_get_resp(buf, sizeof(buf))) != HAL_OK) return err; return hal_io_compare(buf, expected, sizeof(expected)); } static hal_error_t hal_io_get_read_resp(hal_addr_t offset, uint8_t *data) { uint8_t buf[9]; uint8_t expected[4] = { SOR, READ_OK, (offset >> 8) & 0xff, offset & 0xff }; hal_error_t err; if ((err = hal_io_get_resp(buf, sizeof(buf))) != HAL_OK || (err = hal_io_compare(buf, expected, 4)) != HAL_OK) return err; if (buf[8] != EOR) return HAL_ERROR_IO_UNEXPECTED; data[0] = buf[4]; data[1] = buf[5]; data[2] = buf[6]; data[3] = buf[7]; return HAL_OK; } hal_error_t hal_io_write(const hal_core_t *core, hal_addr_t offset, const uint8_t *buf, size_t len) { hal_error_t err; if (core == NULL) return HAL_ERROR_CORE_NOT_FOUND; offset += hal_core_base(core); for (; len > 0; offset++, buf += 4, len -= 4) if ((err = hal_io_send_write_cmd(offset, buf)) != HAL_OK || (err = hal_io_get_write_resp(offset)) != HAL_OK) return err; return HAL_OK; } hal_error_t hal_io_read(const hal_core_t *core, hal_addr_t offset, uint8_t *buf, size_t len) { hal_error_t err; if (core == NULL) return HAL_ERROR_CORE_NOT_FOUND; offset += hal_core_base(core); for (; len > 0; offset++, buf += 4, len -= 4) if ((err = hal_io_send_read_cmd(offset)) != HAL_OK || (err = hal_io_get_read_resp(offset, buf)) != HAL_OK) return err; return HAL_OK; } hal_error_t hal_io_init(const hal_core_t *core) { uint8_t buf[4] = { 0, 0, 0, CTRL_INIT }; return hal_io_write(core, ADDR_CTRL, buf, 4); } hal_error_t hal_io_next(const hal_core_t *core) { uint8_t buf[4] = { 0, 0, 0, CTRL_NEXT }; return hal_io_write(core, ADDR_CTRL, buf, 4); } hal_error_t hal_io_wait(const hal_core_t *core, uint8_t status, int *count) { hal_error_t err; uint8_t buf[4]; int i; for (i = 1; ; ++i) { if (count && (*count > 0) && (i >= *count)) return HAL_ERROR_IO_TIMEOUT; if ((err = hal_io_read(core, ADDR_STATUS, buf, 4)) != HAL_OK) return err; if (buf[3] & status) { if (count) *count = i; return HAL_OK; } } } hal_error_t hal_io_wait_ready(const hal_core_t *core) { int limit = 10; return hal_io_wait(core, STATUS_READY, &limit); } hal_error_t hal_io_wait_valid(const hal_core_t *core) { int limit = 10; return hal_io_wait(core, STATUS_VALID, &limit); } /* * Local variables: * indent-tabs-mode: nil * End: */