Switchtec Userspace PROJECT_NUMBER = 4.2
Loading...
Searching...
No Matches
platform.c
Go to the documentation of this file.
1/*
2 * Microsemi Switchtec(tm) PCIe Management Library
3 * Copyright (c) 2017, Microsemi Corporation
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
22 *
23 */
24
29
30#include "../switchtec_priv.h"
31#include "switchtec/switchtec.h"
32#include "switchtec/gas.h"
33#include "switchtec/gas_mrpc.h"
34#include "switchtec/errors.h"
35
36#include <string.h>
37#include <errno.h>
38
45struct switchtec_dev *switchtec_open_by_path(const char *path);
46
56struct switchtec_dev *switchtec_open_by_index(int index);
57
67struct switchtec_dev *switchtec_open_by_pci_addr(int domain, int bus,
68 int device, int func);
69
77struct switchtec_dev *switchtec_open_i2c(const char *path, int i2c_addr);
78
85struct switchtec_dev *switchtec_open_uart(int fd);
86
94struct switchtec_dev *switchtec_open_eth(const char *ip, const int inst);
95
101void switchtec_close(struct switchtec_dev *dev)
102{
103 if (!dev)
104 return;
105
106 dev->ops->close(dev);
107}
108
117
125int switchtec_get_fw_version(struct switchtec_dev *dev, char *buf,
126 size_t buflen)
127{
128 struct switchtec_fw_part_summary *sum;
129 struct switchtec_fw_image_info *running_img;
130
131 sum = switchtec_fw_part_summary(dev);
132 if (!sum)
133 return -1;
134
135 if (sum->img.active && sum->img.active->running) {
136 running_img = sum->img.active;
137 } else if (sum->img.inactive && sum->img.inactive->running) {
138 running_img = sum->img.inactive;
139 } else {
141 errno = EIO;
142 return -1;
143 }
144
145 strncpy(buf, running_img->version, buflen);
146 buf[buflen - 1] = '\0';
147
149
150 return 0;
151}
152
159int switchtec_get_device_version(struct switchtec_dev *dev, int *res)
160{
161 if (!dev->ops->get_device_version)
162 return 0;
163
164 return dev->ops->get_device_version(dev, res);
165}
166
178int switchtec_cmd(struct switchtec_dev *dev, uint32_t cmd,
179 const void *payload, size_t payload_len, void *resp,
180 size_t resp_len)
181{
182 int ret;
183
184 cmd &= SWITCHTEC_CMD_MASK;
185 cmd |= dev->pax_id << SWITCHTEC_PAX_ID_SHIFT;
186
187 ret = dev->ops->cmd(dev, cmd, payload, payload_len, resp, resp_len);
188 if (ret > 0) {
189 mrpc_error_cmd = cmd & SWITCHTEC_CMD_MASK;
190 errno |= SWITCHTEC_ERRNO_MRPC_FLAG_BIT;
191 }
192
193 return ret;
194}
195
208int switchtec_get_devices(struct switchtec_dev *dev,
209 struct switchtec_status *status,
210 int ports)
211{
212 if (!dev->ops->get_devices)
213 return 0;
214
215 return dev->ops->get_devices(dev, status, ports);
216}
217
227int switchtec_pff_to_port(struct switchtec_dev *dev, int pff,
228 int *partition, int *port)
229{
230 return dev->ops->pff_to_port(dev, pff, partition, port);
231}
232
242int switchtec_port_to_pff(struct switchtec_dev *dev, int partition,
243 int port, int *pff)
244{
245 return dev->ops->port_to_pff(dev, partition, port, pff);
246}
247
269gasptr_t switchtec_gas_map(struct switchtec_dev *dev, int writeable,
270 size_t *map_size)
271{
272 return dev->ops->gas_map(dev, writeable, map_size);
273}
274
281void switchtec_gas_unmap(struct switchtec_dev *dev, gasptr_t map)
282{
283 if (!dev->ops->gas_unmap)
284 return;
285
286 dev->ops->gas_unmap(dev, map);
287}
288
297int switchtec_flash_part(struct switchtec_dev *dev,
298 struct switchtec_fw_image_info *info,
299 enum switchtec_fw_image_part_id_gen3 part)
300{
301 return dev->ops->flash_part(dev, info, part);
302}
303
311int switchtec_event_summary(struct switchtec_dev *dev,
312 struct switchtec_event_summary *sum)
313{
314 return dev->ops->event_summary(dev, sum);
315}
316
327int switchtec_event_ctl(struct switchtec_dev *dev,
328 enum switchtec_event_id e,
329 int index, int flags,
330 uint32_t data[5])
331{
332 return dev->ops->event_ctl(dev, e, index, flags, data);
333}
334
343int switchtec_event_wait(struct switchtec_dev *dev, int timeout_ms)
344{
345 if (!dev->ops->event_wait) {
346 errno = ENOTSUP;
347 return -errno;
348 }
349
350 return dev->ops->event_wait(dev, timeout_ms);
351}
352
360int gas_read8(struct switchtec_dev *dev, uint8_t __gas *addr, uint8_t *val)
361{
362 if (dev->pax_id != dev->local_pax_id)
363 return gas_mrpc_read8(dev, addr, val);
364 else
365 *val = __gas_read8(dev, addr);
366
367 return 0;
368}
369
377int gas_read16(struct switchtec_dev *dev, uint16_t __gas *addr, uint16_t *val)
378{
379 if (dev->pax_id != dev->local_pax_id)
380 return gas_mrpc_read16(dev, addr, val);
381 else
382 *val = __gas_read16(dev, addr);
383
384 return 0;
385}
386
394int gas_read32(struct switchtec_dev *dev, uint32_t __gas *addr, uint32_t *val)
395{
396 if (dev->pax_id != dev->local_pax_id)
397 return gas_mrpc_read32(dev, addr, val);
398 else
399 *val = __gas_read32(dev, addr);
400
401 return 0;
402}
403
411int gas_read64(struct switchtec_dev *dev, uint64_t __gas *addr, uint64_t *val)
412{
413 if (dev->pax_id != dev->local_pax_id)
414 return gas_mrpc_read64(dev, addr, val);
415 else
416 *val = __gas_read64(dev, addr);
417
418 return 0;
419}
420
427void gas_write8(struct switchtec_dev *dev, uint8_t val, uint8_t __gas *addr)
428{
429 if (dev->pax_id != dev->local_pax_id)
430 gas_mrpc_write8(dev, val, addr);
431 else
432 __gas_write8(dev, val, addr);
433}
434
441void gas_write16(struct switchtec_dev *dev, uint16_t val, uint16_t __gas *addr)
442{
443 if (dev->pax_id != dev->local_pax_id)
444 gas_mrpc_write16(dev, val, addr);
445 else
446 __gas_write16(dev, val, addr);
447}
448
455void gas_write32(struct switchtec_dev *dev, uint32_t val, uint32_t __gas *addr)
456{
457 if (dev->pax_id != dev->local_pax_id)
458 gas_mrpc_write32(dev, val, addr);
459 else
460 __gas_write32(dev, val, addr);
461}
462
469void gas_write64(struct switchtec_dev *dev, uint64_t val, uint64_t __gas *addr)
470{
471 if (dev->pax_id != dev->local_pax_id)
472 gas_mrpc_write64(dev, val, addr);
473 else
474 __gas_write64(dev, val, addr);
475}
476
484void memcpy_to_gas(struct switchtec_dev *dev, void __gas *dest,
485 const void *src, size_t n)
486{
487 if (dev->pax_id != dev->local_pax_id)
488 gas_mrpc_memcpy_to_gas(dev, dest, src, n);
489 else
490 __memcpy_to_gas(dev, dest, src, n);
491}
492
501int memcpy_from_gas(struct switchtec_dev *dev, void *dest,
502 const void __gas *src, size_t n)
503{
504 if (dev->pax_id != dev->local_pax_id)
505 return gas_mrpc_memcpy_from_gas(dev, dest, src, n);
506 else
507 __memcpy_from_gas(dev, dest, src, n);
508
509 return 0;
510}
511
519ssize_t write_from_gas(struct switchtec_dev *dev, int fd,
520 const void __gas *src, size_t n)
521{
522 if (dev->pax_id != dev->local_pax_id)
523 return gas_mrpc_write_from_gas(dev, fd, src, n);
524 else
525 return __write_from_gas(dev, fd, src, n);
526}
GAS Accessor functions.
struct switchtec_dev * switchtec_open_uart(int fd)
Open a switchtec device behind a uart device.
int switchtec_list(struct switchtec_device_info **devlist)
List all the switchtec devices in the system.
struct switchtec_dev * switchtec_open_by_index(int index)
Open a switchtec device by index.
int switchtec_cmd(struct switchtec_dev *dev, uint32_t cmd, const void *payload, size_t payload_len, void *resp, size_t resp_len)
Execute an MRPC command.
Definition platform.c:178
void switchtec_close(struct switchtec_dev *dev)
Close a Switchtec device handle.
Definition platform.c:101
int mrpc_error_cmd
The MRPC command ID when errno is set.
Definition switchtec.c:608
struct switchtec_dev * switchtec_open_i2c(const char *path, int i2c_addr)
Open a switchtec device behind an I2C device.
struct switchtec_dev * switchtec_open_by_path(const char *path)
Open a switchtec device by path.
struct switchtec_dev * switchtec_open_eth(const char *ip, const int inst)
Open a switchtec device over ethernet.
int switchtec_get_devices(struct switchtec_dev *dev, struct switchtec_status *status, int ports)
Populate an already retrieved switchtec_status structure list with information about the devices plug...
Definition platform.c:208
int switchtec_get_device_version(struct switchtec_dev *dev, int *res)
Get the minor version number as a user readable int.
Definition platform.c:159
int switchtec_get_fw_version(struct switchtec_dev *dev, char *buf, size_t buflen)
Get the firmware version as a user readable string.
Definition platform.c:125
struct switchtec_dev * switchtec_open_by_pci_addr(int domain, int bus, int device, int func)
Open a switchtec device by PCI address (BDF).
int switchtec_event_ctl(struct switchtec_dev *dev, enum switchtec_event_id e, int index, int flags, uint32_t data[5])
Enable, disable and clear events or retrieve event data.
Definition platform.c:327
int switchtec_event_summary(struct switchtec_dev *dev, struct switchtec_event_summary *sum)
Retrieve a summary of all the events that have occurred in the switch.
Definition platform.c:311
int switchtec_event_wait(struct switchtec_dev *dev, int timeout_ms)
Wait for any event to occur (typically just an interrupt).
Definition platform.c:343
void switchtec_fw_part_summary_free(struct switchtec_fw_part_summary *summary)
Free a firmware part summary data structure.
Definition fw.c:1726
struct switchtec_fw_part_summary * switchtec_fw_part_summary(struct switchtec_dev *dev)
Return firmware summary information structure for the flash partitfons in the device.
Definition fw.c:1634
int switchtec_flash_part(struct switchtec_dev *dev, struct switchtec_fw_image_info *info, enum switchtec_fw_image_part_id_gen3 part)
Retrieve information about a flash partition.
Definition platform.c:297
void gas_mrpc_memcpy_to_gas(struct switchtec_dev *dev, void __gas *dest, const void *src, size_t n)
Copy data to the GAS using MRPC commands.
Definition gas_mrpc.c:59
int gas_mrpc_memcpy_from_gas(struct switchtec_dev *dev, void *dest, const void __gas *src, size_t n)
Copy data from the GAS using MRPC commands.
Definition gas_mrpc.c:94
ssize_t gas_mrpc_write_from_gas(struct switchtec_dev *dev, int fd, const void __gas *src, size_t n)
Call write() with data from the GAS using an MRPC command.
Definition gas_mrpc.c:131
void memcpy_to_gas(struct switchtec_dev *dev, void __gas *dest, const void *src, size_t n)
Copy data to the GAS.
Definition platform.c:484
ssize_t write_from_gas(struct switchtec_dev *dev, int fd, const void __gas *src, size_t n)
Call write() with data from the GAS.
Definition platform.c:519
gasptr_t switchtec_gas_map(struct switchtec_dev *dev, int writeable, size_t *map_size)
Map the GAS and return a pointer to access the gas.
Definition platform.c:269
void gas_write16(struct switchtec_dev *dev, uint16_t val, uint16_t __gas *addr)
Write a uint16_t to the GAS.
Definition platform.c:441
void switchtec_gas_unmap(struct switchtec_dev *dev, gasptr_t map)
Unmap the GAS region mapped with.
Definition platform.c:281
void gas_write64(struct switchtec_dev *dev, uint64_t val, uint64_t __gas *addr)
Write a uint64_t to the GAS.
Definition platform.c:469
void gas_write32(struct switchtec_dev *dev, uint32_t val, uint32_t __gas *addr)
Write a uint32_t to the GAS.
Definition platform.c:455
void gas_write8(struct switchtec_dev *dev, uint8_t val, uint8_t __gas *addr)
Write a uint8_t to the GAS.
Definition platform.c:427
int switchtec_port_to_pff(struct switchtec_dev *dev, int partition, int port, int *pff)
Convert a partition and port number to a port function index.
Definition platform.c:242
int switchtec_pff_to_port(struct switchtec_dev *dev, int pff, int *partition, int *port)
Convert a port function index to a partition and port number.
Definition platform.c:227
int gas_read32(struct switchtec_dev *dev, uint32_t __gas *addr, uint32_t *val)
Read a uint32_t from the GAS.
Definition platform.c:394
int gas_read16(struct switchtec_dev *dev, uint16_t __gas *addr, uint16_t *val)
Read a uint16_t from the GAS.
Definition platform.c:377
int memcpy_from_gas(struct switchtec_dev *dev, void *dest, const void __gas *src, size_t n)
Copy data from the GAS.
Definition platform.c:501
int gas_read8(struct switchtec_dev *dev, uint8_t __gas *addr, uint8_t *val)
Read a uint8_t from the GAS.
Definition platform.c:360
int gas_read64(struct switchtec_dev *dev, uint64_t __gas *addr, uint64_t *val)
Read a uint64_t from the GAS.
Definition platform.c:411
Represents a Switchtec device in the switchtec_list() function.
Definition switchtec.h:147
Event summary bitmaps.
Definition switchtec.h:308
Information about a firmware image or partition.
Definition switchtec.h:270
char version[32]
Firmware/Config version.
Definition switchtec.h:274
Port status structure.
Definition switchtec.h:176
Main Switchtec header.
switchtec_event_id
Enumeration of all possible events.
Definition switchtec.h:323
__gas struct switchtec_gas * gasptr_t
Shortform for a pointer to the GAS register space.
Definition switchtec.h:85