/* Copyright 2016 IBM Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef __TARGET_H
#define __TARGET_H

#include <stdint.h>
#include <ccan/list/list.h>
#include <ccan/container_of/container_of.h>
#include "compiler.h"
#include "device.h"

#define PR_DEBUG(x, args...) \
	fprintf(stderr, x, ##args)
#define PR_INFO(x, args...) \
	fprintf(stderr, x, ##args)
#define PR_ERROR(x, args...) \
	fprintf(stderr, "%s: " x, __FUNCTION__, ##args)

enum chip_type {CHIP_UNKNOWN, CHIP_P8, CHIP_P8NV, CHIP_P9};

struct target_class {
	char *name;
	struct list_head targets;
	struct list_node class_head_link;
};

struct target {
	char *name;
	char *compatible;
	char *class;
	int (*probe)(struct target *target);
	int index;
	struct dt_node *dn;
	struct list_node class_link;
};

struct target *require_target_parent(struct target *target);
struct target_class *find_target_class(const char *name);
struct target_class *require_target_class(const char *name);

extern struct list_head empty_list;
#define for_each_class_target(class_name, target)			\
	list_for_each((find_target_class(class_name) ? &require_target_class(class_name)->targets : &empty_list), target, class_link)

struct hw_unit_info {
	void *hw_unit;
	size_t size;
	size_t struct_target_offset;
};

/* We can't pack the structs themselves directly into a special
 * section because there doesn't seem to be any standard way of doing
 * that due to alignment rules. So instead we pack pointers into a
 * special section. */
#define DECLARE_HW_UNIT(name)						\
	const struct hw_unit_info __used name ##_hw_unit = \
	{ .hw_unit = &name, .size = sizeof(name), .struct_target_offset = container_off(typeof(name), target) }; \
	const struct hw_unit_info __used __section("hw_units") *name ##_hw_unit_p = &name ##_hw_unit

struct adu {
	struct target target;
	int (*getmem)(struct adu *, uint64_t, uint64_t *);
	int (*putmem)(struct adu *, uint64_t, uint64_t, int);
};
#define target_to_adu(x) container_of(x, struct adu, target)

struct pib {
	struct target target;
	int (*read)(struct pib *, uint64_t, uint64_t *);
	int (*write)(struct pib *, uint64_t, uint64_t);
	void *priv;
};
#define target_to_pib(x) container_of(x, struct pib, target)

struct opb {
	struct target target;
	int (*read)(struct opb *, uint32_t, uint32_t *);
	int (*write)(struct opb *, uint32_t, uint32_t);
};
#define target_to_opb(x) container_of(x, struct opb, target)

struct fsi {
	struct target target;
	int (*read)(struct fsi *, uint32_t, uint32_t *);
	int (*write)(struct fsi *, uint32_t, uint32_t);
	enum chip_type chip_type;
};
#define target_to_fsi(x) container_of(x, struct fsi, target)

struct chiplet {
	struct target target;
};
#define target_to_chiplet(x) container_of(x, struct chiplet, target)

struct thread {
	struct target target;
	uint64_t status;
	int id;
	int (*step)(struct thread *, int);
	int (*start)(struct thread *);
	int (*stop)(struct thread *);

	/* ram_setup() should be called prior to using ram_instruction() to
	 * actually ram the instruction and return the result. ram_destroy()
	 * should be called at completion to clean-up. */
	int (*ram_setup)(struct thread *);
	int (*ram_instruction)(struct thread *, uint64_t opcode, uint64_t *scratch);
	int (*ram_destroy)(struct thread *);
};
#define target_to_thread(x) container_of(x, struct thread, target)

void targets_init(void *fdt);
void target_probe(void);

int pib_read(struct target *pib_dt, uint64_t addr, uint64_t *data);
int pib_write(struct target *pib_dt, uint64_t addr, uint64_t data);
int opb_read(struct target *opb_dt, uint32_t addr, uint32_t *data);
int opb_write(struct target *opb_dt, uint32_t addr, uint32_t data);
int fsi_read(struct target *fsi_dt, uint32_t addr, uint32_t *data);
int fsi_write(struct target *fsi_dt, uint32_t addr, uint32_t data);

#endif